OverviewPlatformsAPI Reference

Get an automation

gethttps://api.mentio.dev/v1/automations/{id}

Authentication

AuthorizationBearer <token>Required

An API key (mk_live_...) from the dashboard or an OAuth access token. See Authentication.

Path parameters

idstringRequired

Automation id (atm_...).

1 to ∞ characters

Response

200The automation
idstringRequired

Automation id (atm_...).

namestringRequired

Automation name, unique in the workspace.

enabledbooleanRequired

false: kept but not run.

filterobjectRequired

Which mentions it acts on: the fields of GET /v1/mentions, like a view.

+Show 46 properties
qstringOptional

Substring in the post text or the author's name.

1 to 200 characters
keywordIdsarray<string>Optional

Only matches of any of these keywords.

0 to 50 items
notKeywordIdsarray<string>Optional

Never matches of these keywords.

0 to 50 items
keywordKindsarray<string>Optional

Only matches of keywords of any of these kinds: brand, competitor, topic.

One ofbrandcompetitortopic0 to 3 items
notKeywordKindsarray<string>Optional

Never matches of keywords of these kinds.

One ofbrandcompetitortopic0 to 3 items
groupIdsarray<string>Optional

Only matches of keywords in any of these groups (grp_...).

0 to 50 items
notGroupIdsarray<string>Optional

Never matches of keywords in these groups.

0 to 50 items
platformsarray<string>Optional

Only posts from any of these platforms.

0 to 20 items
+Show 18 enum values
blueskyhackernewsgithubstackoverflowdevtoredditxyoutubenewslinkedintiktokinstagramfacebookappstoregoogleplaytrustpilotgooglemapsrss
notPlatformsarray<string>Optional

Never posts from these platforms.

0 to 20 items
+Show 18 enum values
blueskyhackernewsgithubstackoverflowdevtoredditxyoutubenewslinkedintiktokinstagramfacebookappstoregoogleplaytrustpilotgooglemapsrss
statusstringOptional

Only mentions in this status: open, ignored, done.

One ofopenignoreddone
relevantbooleanOptional

true: only mentions the classifier scored relevant; false: only the rest.

minRelevanceintegerOptional

Only mentions scored at least this.

0 to 100
minConfidencenumberOptional

Only mentions whose classifier confidence is at least this.

0 to 1
sentimentsarray<string>Optional

Only these sentiments.

One ofpositiveneutralnegative0 to 3 items
notSentimentsarray<string>Optional

Never these sentiments; an unscored mention still passes.

One ofpositiveneutralnegative0 to 3 items
intentsarray<string>Optional

Only mentions carrying any of these intent or topic tags.

0 to 20 items
notIntentsarray<string>Optional

Never mentions carrying these tags.

0 to 20 items
automatedbooleanOptional

true: only posts that read as machine-made; false: only the rest.

languagesarray<string>Optional

Only posts in any of these languages (ISO 639-1).

0 to 20 items
notLanguagesarray<string>Optional

Never posts in these languages; an unknown language still passes.

0 to 20 items
countriesarray<string>Optional

Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.

0 to 100 items
+Show 60 enum values
uscamxbrarcoclpegbiefrdeesptitnlbechatsenodkfiplczrogrhuuarultlveetrilaesaegngkezamainpkbdlknpcnhktwjpkrsgmyidphvnthaunz
notCountriesarray<string>Optional

Never posts whose author is in these countries; an unknown country still passes.

0 to 100 items
+Show 60 enum values
uscamxbrarcoclpegbiefrdeesptitnlbechatsenodkfiplczrogrhuuarultlveetrilaesaegngkezamainpkbdlknpcnhktwjpkrsgmyidphvnthaunz
organizationbooleanOptional

true: only posts by companies, brands and organizations; false: only posts by people.

tagsarray<string>Optional

Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.

0 to 20 items
notTagsarray<string>Optional

Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.

0 to 20 items
labelsarray<string>Optional

Only mentions carrying any of these labels (exact, case-sensitive).

0 to 20 items
notLabelsarray<string>Optional

Never mentions carrying any of these labels.

0 to 20 items
linkHostsarray<string>Optional

Only posts linking to any of these hosts, the host itself or a subdomain of it.

0 to 20 items
notLinkHostsarray<string>Optional

Never posts linking to these hosts.

0 to 20 items
subredditsarray<string>Optional

Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.

0 to 50 items
notSubredditsarray<string>Optional

Never Reddit posts from these subreddits; posts from other platforms still pass.

0 to 50 items
minFollowersintegerOptional

Only authors with at least this many followers; unknown reach never passes.

0 to ∞
maxFollowersintegerOptional

Only authors with at most this many followers; unknown reach never passes.

0 to ∞
isReplybooleanOptional

true: only replies and comments; false: only top-level posts.

kindstringOptional

Only posts (post), only comments (comment) or only GitHub repository events (repository).

One ofpostcommentrepository
notAuthorsarray<string>Optional

Never these authors: display names, handles or profile URLs.

0 to 200 items
excludeAuthorsarray<string>Optional

Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.

0 to 200 items
ratingsarray<integer>Optional

Only app store reviews with any of these star ratings; every other post fails it.

0 to 5 items
notRatingsarray<integer>Optional

Never reviews with these star ratings; posts that are not reviews still pass.

0 to 5 items
minLikesintegerOptional

Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minRepostsintegerOptional

Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minRepliesintegerOptional

Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minQuotesintegerOptional

Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minViewsintegerOptional

Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minBookmarksintegerOptional

Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
anyOfarray<object>Optional

OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See anyOf.

1 to 10 items
+Show 45 properties
qstringOptional

Substring in the post text or the author's name.

1 to 200 characters
keywordIdsarray<string>Optional

Only matches of any of these keywords.

0 to 50 items
notKeywordIdsarray<string>Optional

Never matches of these keywords.

0 to 50 items
keywordKindsarray<string>Optional

Only matches of keywords of any of these kinds: brand, competitor, topic.

One ofbrandcompetitortopic0 to 3 items
notKeywordKindsarray<string>Optional

Never matches of keywords of these kinds.

One ofbrandcompetitortopic0 to 3 items
groupIdsarray<string>Optional

Only matches of keywords in any of these groups (grp_...).

0 to 50 items
notGroupIdsarray<string>Optional

Never matches of keywords in these groups.

0 to 50 items
platformsarray<string>Optional

Only posts from any of these platforms.

0 to 20 items
+Show 18 enum values
blueskyhackernewsgithubstackoverflowdevtoredditxyoutubenewslinkedintiktokinstagramfacebookappstoregoogleplaytrustpilotgooglemapsrss
notPlatformsarray<string>Optional

Never posts from these platforms.

0 to 20 items
+Show 18 enum values
blueskyhackernewsgithubstackoverflowdevtoredditxyoutubenewslinkedintiktokinstagramfacebookappstoregoogleplaytrustpilotgooglemapsrss
statusstringOptional

Only mentions in this status: open, ignored, done.

One ofopenignoreddone
relevantbooleanOptional

true: only mentions the classifier scored relevant; false: only the rest.

minRelevanceintegerOptional

Only mentions scored at least this.

0 to 100
minConfidencenumberOptional

Only mentions whose classifier confidence is at least this.

0 to 1
sentimentsarray<string>Optional

Only these sentiments.

One ofpositiveneutralnegative0 to 3 items
notSentimentsarray<string>Optional

Never these sentiments; an unscored mention still passes.

One ofpositiveneutralnegative0 to 3 items
intentsarray<string>Optional

Only mentions carrying any of these intent or topic tags.

0 to 20 items
notIntentsarray<string>Optional

Never mentions carrying these tags.

0 to 20 items
automatedbooleanOptional

true: only posts that read as machine-made; false: only the rest.

languagesarray<string>Optional

Only posts in any of these languages (ISO 639-1).

0 to 20 items
notLanguagesarray<string>Optional

Never posts in these languages; an unknown language still passes.

0 to 20 items
countriesarray<string>Optional

Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.

0 to 100 items
+Show 60 enum values
uscamxbrarcoclpegbiefrdeesptitnlbechatsenodkfiplczrogrhuuarultlveetrilaesaegngkezamainpkbdlknpcnhktwjpkrsgmyidphvnthaunz
notCountriesarray<string>Optional

Never posts whose author is in these countries; an unknown country still passes.

0 to 100 items
+Show 60 enum values
uscamxbrarcoclpegbiefrdeesptitnlbechatsenodkfiplczrogrhuuarultlveetrilaesaegngkezamainpkbdlknpcnhktwjpkrsgmyidphvnthaunz
organizationbooleanOptional

true: only posts by companies, brands and organizations; false: only posts by people.

tagsarray<string>Optional

Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.

0 to 20 items
notTagsarray<string>Optional

Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.

0 to 20 items
labelsarray<string>Optional

Only mentions carrying any of these labels (exact, case-sensitive).

0 to 20 items
notLabelsarray<string>Optional

Never mentions carrying any of these labels.

0 to 20 items
linkHostsarray<string>Optional

Only posts linking to any of these hosts, the host itself or a subdomain of it.

0 to 20 items
notLinkHostsarray<string>Optional

Never posts linking to these hosts.

0 to 20 items
subredditsarray<string>Optional

Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.

0 to 50 items
notSubredditsarray<string>Optional

Never Reddit posts from these subreddits; posts from other platforms still pass.

0 to 50 items
minFollowersintegerOptional

Only authors with at least this many followers; unknown reach never passes.

0 to ∞
maxFollowersintegerOptional

Only authors with at most this many followers; unknown reach never passes.

0 to ∞
isReplybooleanOptional

true: only replies and comments; false: only top-level posts.

kindstringOptional

Only posts (post), only comments (comment) or only GitHub repository events (repository).

One ofpostcommentrepository
notAuthorsarray<string>Optional

Never these authors: display names, handles or profile URLs.

0 to 200 items
excludeAuthorsarray<string>Optional

Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.

0 to 200 items
ratingsarray<integer>Optional

Only app store reviews with any of these star ratings; every other post fails it.

0 to 5 items
notRatingsarray<integer>Optional

Never reviews with these star ratings; posts that are not reviews still pass.

0 to 5 items
minLikesintegerOptional

Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minRepostsintegerOptional

Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minRepliesintegerOptional

Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minQuotesintegerOptional

Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minViewsintegerOptional

Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
minBookmarksintegerOptional

Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.

0 to ∞
actionsobjectRequired

What it does to each mention the filter selects.

+Show 2 properties
addLabelsarray<string>Required

Labels it adds.

assigneeIdstringnullableRequired

The member it assigns, or null.

createdAtstringRequired

ISO 8601 timestamp, UTC.

updatedAtstringRequired

ISO 8601 timestamp, UTC.

401Missing or invalid API key
+Show 1 property
errorobjectRequired

The error.

+Show 4 properties
codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 49 enum values
unauthorizedforbiddenread_only_keyvalidation_errornot_foundinvalid_cursorpayload_too_largeidempotency_key_in_useidempotency_key_reusedrate_limitedduplicate_keywordinsufficient_balancekeyword_limit_reachedbilling_not_configuredorder_not_creditedschedule_requiredunknown_channelnot_a_digesthourly_email_unsupportedslack_not_connectedslack_not_configuredtelegram_not_configuredfeed_unreadablefeed_login_requiredfeed_login_expiredfeed_limit_reachedfeed_auth_not_configuredemail_not_configuredinvalid_assigneeclassification_pendinginvalid_memberalready_memberlast_ownerduplicate_segmentfilter_too_complexduplicate_viewduplicate_automationautomation_filter_unreadableautomation_limit_reachedduplicate_groupdefault_groupdefault_group_contextgroup_changedinvalid_signaturewebhook_not_configuredinvalid_tokenprotected_userupstream_unavailableinternal_error
messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

404No such automation in this workspace
+Show 1 property
errorobjectRequired

The error.

+Show 4 properties
codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 49 enum values
unauthorizedforbiddenread_only_keyvalidation_errornot_foundinvalid_cursorpayload_too_largeidempotency_key_in_useidempotency_key_reusedrate_limitedduplicate_keywordinsufficient_balancekeyword_limit_reachedbilling_not_configuredorder_not_creditedschedule_requiredunknown_channelnot_a_digesthourly_email_unsupportedslack_not_connectedslack_not_configuredtelegram_not_configuredfeed_unreadablefeed_login_requiredfeed_login_expiredfeed_limit_reachedfeed_auth_not_configuredemail_not_configuredinvalid_assigneeclassification_pendinginvalid_memberalready_memberlast_ownerduplicate_segmentfilter_too_complexduplicate_viewduplicate_automationautomation_filter_unreadableautomation_limit_reachedduplicate_groupdefault_groupdefault_group_contextgroup_changedinvalid_signaturewebhook_not_configuredinvalid_tokenprotected_userupstream_unavailableinternal_error
messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).