MCP-Server
Mentio
dev.mentio/mcp
Was dieses MCP kann
Tracks and analyzes brand, competitor, topic, review, sentiment, intent, and audience mentions across social and review platforms, with alerts and outreach logs.
Funktionen
Tools
55
Tools
add_keyword
Add keyword
Start tracking a keyword. kind is "brand" (default), "competitor" or "topic". platforms optionally restricts it to some platforms (default: every platform). New mentions containing the term will be matched, classified and delivered. For a common word, narrow it with `matching` (requiredTerms with requiredMode any|all, excludedTerms with a `*` wildcard at an end, excludedAuthors, caseSensitive): a post the rules reject is never stored or billed. `context` is one sentence the classifier reads for this keyword only ("Arc is our browser; ignore the geometry word"). `cap` ({ mentions: N }) is a monthly ceiling on its matched mentions: at the cap it stops matching until the first of the next month (UTC) or until the cap is raised, while its daily keyword charge continues. `groupId` puts it in a keyword group (list_groups; default: the workspace's default group); a term may be tracked once per group, so two groups may track the same term as two keywords. `reviewSources` collects reviews: pass each page's link (url: an App Store or Google Play app, a Trustpilot page, a Google Maps place or its maps.app.goo.gl share link) or platform (appstore|googleplay|trustpilot|googlemaps) and id; the app stores also take countries (two-letter codes, default us) and Google Play a language (default en). Every review of the page becomes a mention of this keyword, polled daily, and the last 30 days (newest 100) come in free at once. `platforms: []` makes a reviews-only keyword.
Eingabeschema
{'type': 'object', 'required': ['term'], 'properties': {'cap': {'anyOf': [{'type': 'object', 'required': ['mentions'], 'properties': {'mentions': {'type': 'integer', 'maximum': 1000000, 'minimum': 1, 'description': 'Matched mentions allowed per calendar month (UTC). Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.'}}, 'description': 'A monthly ceiling on the mentions this keyword may match. At the cap it stops matching until the first of the next month (UTC), or until the cap is raised or removed. It stays unmuted: it keeps its place and its daily keyword charge; pause it to stop that too.', 'additionalProperties': False}, {'type': 'null'}], 'description': 'A monthly mention cap; omit or null for none.'}, 'kind': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string', 'default': 'brand', 'description': 'brand: your own names. competitor: theirs. topic: the space. Drives share of voice and segments.'}, 'term': {'type': 'string', 'maxLength': 80, 'minLength': 2, 'description': 'The word or phrase to track, matched case-insensitively as a phrase.'}, 'context': {'anyOf': [{'type': 'string', 'maxLength': 300, 'description': 'A sentence the classifier reads for this keyword only, on top of the company profile or the group\'s own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.'}, {'type': 'null'}], 'description': 'A sentence the classifier reads for this keyword only, on top of the company profile or the group\'s own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.'}, 'groupId': {'type': 'string', 'minLength': 1, 'description': "The group to track it in (grp_...); omit for the workspace's default group. A term may be tracked once per group."}, 'matching': {'type': 'object', 'properties': {'requiredMode': {'enum': ['any', 'all'], 'type': 'string', 'description': 'any: at least one required term must appear. all: every one must.'}, 'caseSensitive': {'type': 'boolean', 'description': 'true: the term must appear in the case it was typed (RAG, never rag). Default false.'}, 'excludedTerms': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 50, 'description': 'A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).'}, 'requiredTerms': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 50, 'description': 'The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.'}, 'excludedAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 500, 'minLength': 1}, 'maxItems': 100, 'description': "Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list."}}, 'description': 'Omitted fields are untouched; an empty list clears one.', 'additionalProperties': False}, 'platforms': {'anyOf': [{'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram'], 'type': 'string'}}, {'type': 'null'}], 'description': 'Platforms to search the term on; omit or null for every platform. [] searches it nowhere: a keyword that only collects reviews, which then needs reviewSources.'}, 'reviewSources': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'The id on the platform: the digits after "id" on the App Store, the package name on Google Play, the company\'s domain on Trustpilot (notion.so), a Place ID (ChIJ...) on Google Maps.'}, 'url': {'type': 'string', 'maxLength': 500, 'minLength': 1, 'description': "The review page's link: an App Store or Google Play app (https://apps.apple.com/us/app/notion/id1232780281, https://play.google.com/store/apps/details?id=notion.id), a Trustpilot page (https://www.trustpilot.com/review/notion.so) or a Google Maps place (its full link, or a maps.app.goo.gl share link). Or give platform and id."}, 'language': {'type': 'string', 'maxLength': 10, 'minLength': 2, 'description': "Google Play only: the language of the reviews to read (en, es, de, pt-BR); Google Play answers one language at a time. Default: the link's hl, else en."}, 'platform': {'enum': ['appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': "appstore (Apple App Store), googleplay (Google Play), trustpilot (a company's Trustpilot page) or googlemaps (a place's Google reviews)."}, 'countries': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[A-Za-z]{2}$'}, 'maxItems': 20, 'minItems': 1, 'description': 'App Store and Google Play only: storefronts to read, two-letter codes, at most 20. Default: the one in the link, else us. Each is one more poll a day; the same review seen in two storefronts is one mention. Trustpilot and Google Maps have one page for everyone and take none.'}}, 'description': "A review page whose reviews become this keyword's mentions: its link, or the platform and the id.", 'additionalProperties': False}, 'maxItems': 10, 'description': 'Review pages this keyword collects, at most 10: App Store and Google Play apps, Trustpilot pages, Google Maps places. Every new review of one is a mention of the keyword, whatever its text says. Polled once a day (per country on the app stores). A newly connected page brings its last 30 days, the newest 100 reviews (per country), free and never sent as instant alerts; after that each review bills like any mention.'}}, 'additionalProperties': False}
create_alert
Create alert
Create an alert rule. mode "instant" sends each matching mention as it happens; "hourly" sends one digest every UTC hour (five minutes past) for the previous hour, nothing when it had no mention over the floor, takes no schedule and no email channel (Slack, Telegram, webhook); "daily" sends one digest at schedule.hour in schedule.timezone; "weekly" sends one a week on schedule.weekday (0 Sunday to 6 Saturday). filter narrows by keywordIds, platforms, minRelevance (the relevance floor: absent sends relevant mentions only, 40 and up; 0 sends every scored match, noise included), minConfidence, sentiments, intents, excludeAuthors, minFollowers, tags, linkHosts (the hosts a post links to, a host or any subdomain of it). channelIds come from list_channels.
Eingabeschema
{'type': 'object', 'required': ['name'], 'properties': {'mode': {'enum': ['instant', 'hourly', 'daily', 'weekly'], 'type': 'string', 'default': 'instant'}, 'name': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'event': {'anyOf': [{'type': 'string', 'pattern': '^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)*$', 'maxLength': 60}, {'type': 'null'}], 'description': 'Custom event name for webhook payloads; null for the mode default.'}, 'filter': {'type': 'object', 'default': {}, 'properties': {'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'anyOf': {'type': 'array', 'items': {'type': 'object', 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': "Substring in the post text or the author's name."}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'Only mentions in this status: open, ignored, done.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only mentions carrying any of these intent or topic tags.'}, 'isReply': {'type': 'boolean', 'description': 'true: only replies and comments; false: only top-level posts.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never authors tagged with any of these.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings; every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of keywords in any of these groups (grp_...).'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'relevant': {'type': 'boolean', 'description': 'true: only mentions the classifier scored relevant; false: only the rest.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made; false: only the rest.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1).'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only posts from any of these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of any of these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never mentions carrying these tags.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings; posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Only these sentiments.'}, 'notGroupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of keywords in these groups.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only matches of keywords of any of these kinds: brand, competitor, topic.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at most this many followers; unknown reach never passes.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers; unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Only mentions scored at least this.'}, 'notLanguages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Never posts in these languages; an unknown language still passes.'}, 'notLinkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never posts linking to these hosts.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Never posts from these platforms.'}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this.'}, 'notKeywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of these keywords.'}, 'notSentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Never these sentiments; an unscored mention still passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'description': 'A group of conditions, all of which must hold: the vocabulary of a view filter, without anyOf.', 'additionalProperties': False}, 'maxItems': 10, 'minItems': 1, 'description': 'OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.'}, 'intents': {'type': 'array', 'items': {'type': 'string'}, 'description': 'At least one of these intent or topic tags.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Only keywords in these groups (grp_...): one rule per customer, say.'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'description': 'Only posts from these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Only these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'description': 'Only these sentiments.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers. Unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': "The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass."}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this, 0 to 1. A mention without a confidence never passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'additionalProperties': False}, 'enabled': {'type': 'boolean', 'default': True}, 'schedule': {'type': 'object', 'required': ['hour', 'timezone'], 'properties': {'hour': {'type': 'integer', 'maximum': 23, 'minimum': 0}, 'minute': {'type': 'integer', 'default': 0, 'maximum': 59, 'minimum': 0}, 'weekday': {'type': 'integer', 'maximum': 6, 'minimum': 0, 'description': 'Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.'}, 'timezone': {'type': 'string', 'maxLength': 64, 'minLength': 1}, 'skipEmpty': {'type': 'boolean', 'default': True}}, 'description': 'Required for daily and weekly alerts (weekly ones also need schedule.weekday). Hourly alerts take none: they send every UTC hour, so a time of day and a zone are ignored and a weekday is refused.', 'additionalProperties': False}, 'channelIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'default': [], 'maxItems': 20, 'description': 'Channel ids from GET /v1/channels.'}}, 'additionalProperties': False}
create_group
Create group
Create a keyword group: a name (unique per workspace), optionally your own id for it (externalId, unique too, a customer id say), and optionally its own company description (context: who the business is, what it sells, for whom), which the classifier reads in place of the whole workspace profile (guidelines and competitors included) for this group's keywords, so a rule for the group goes in that text. One group per customer with its description is how a reseller gets each customer judged as itself. Then pass its id as groupId to add_keyword.
Eingabeschema
{'type': 'object', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The group's name: a customer, a campaign, a product. Unique per workspace."}, 'context': {'anyOf': [{'type': 'string', 'maxLength': 4000, 'description': 'What the classifier reads as "the company" for this group\'s keywords, in place of the WHOLE workspace profile, its relevance guidelines and competitor list included (at most 4000 characters): who the business is, what it sells, for whom, what is not it, and any rule that should apply to this group ("ignore job posts"). For a group per customer, the customer\'s description. Null: the workspace profile, as for every keyword before groups.'}, {'type': 'null'}], 'description': 'What the classifier reads as "the company" for this group\'s keywords, in place of the WHOLE workspace profile, its relevance guidelines and competitor list included (at most 4000 characters): who the business is, what it sells, for whom, what is not it, and any rule that should apply to this group ("ignore job posts"). For a group per customer, the customer\'s description. Null: the workspace profile, as for every keyword before groups.'}, 'externalId': {'anyOf': [{'type': 'string', 'maxLength': 128, 'minLength': 1, 'description': 'Your own id for the group (a customer id, say). Unique per workspace; find the group by it with GET /v1/groups?externalId=.'}, {'type': 'null'}], 'description': 'Your own id for the group (a customer id, say). Unique per workspace; find the group by it with GET /v1/groups?externalId=.'}}, 'additionalProperties': False}
create_segment
Create segment
Save an audience segment: a name plus a filter (platforms, tags, follower range, minimum mentions or negatives, intents seen, keyword kinds mentioned or never mentioned, first seen within N days, linkHosts they have shared a link to). Evaluated on every read, never materialized.
Eingabeschema
{'type': 'object', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'filter': {'type': 'object', 'default': {}, 'properties': {'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'People carrying any of these tags.'}, 'muted': {'type': 'boolean', 'description': 'true: only muted people; false: only unmuted.'}, 'stages': {'type': 'array', 'items': {'enum': ['not_contacted', 'contacted', 'replied', 'in_talks', 'customer', 'not_a_fit'], 'type': 'string', 'description': 'Where your workspace stands with the person: not_contacted, contacted, replied, in_talks, customer or not_a_fit.'}, 'maxItems': 6, 'description': 'People at any of these outreach stages.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 10, 'description': 'At least one mention carrying any of these intents.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Nobody carrying any of these tags.'}, 'ownerIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'People owned by any of these members (user ids); "none" matches people nobody owns.'}, 'automated': {'type': 'boolean', 'description': 'true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'At least one mention linking to any of these hosts, the host itself or a subdomain of it.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'People with an account on any of these platforms.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 10, 'description': 'Nobody whose mentions carry any of these intents.'}, 'minMentions': {'type': 'integer', 'minimum': 1, 'description': 'At least this many matched mentions.'}, 'minNegative': {'type': 'integer', 'minimum': 1, 'description': 'At least this many negative mentions.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Mentioned a keyword of any of these kinds.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'At most this many followers. Unknown reach never matches.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'At least this many followers. Unknown reach never matches.'}, 'newSinceDays': {'type': 'integer', 'maximum': 365, 'minimum': 1, 'description': 'First seen within this many days.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Nobody with an account on these platforms.'}, 'neverKeywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Never mentioned a keyword of these kinds.'}}, 'additionalProperties': False}, 'description': {'type': 'string', 'default': '', 'maxLength': 500}}, 'additionalProperties': False}
create_view
Create view
Save a view: a name plus a filter in the vocabulary of search_mentions (keywords or keyword kinds, platforms, status, relevant, sentiments, intents, languages, author tags, follower range, replies, link hosts, automated, free text), lists any-of, `not` lists none-of, every condition ANDed, plus anyOf for OR: groups of those conditions, at least one of which must hold. Nothing is materialized: the view selects whatever matches when it is read.
Eingabeschema
{'type': 'object', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': 'Unique per workspace, case-insensitive.'}, 'filter': {'type': 'object', 'default': {}, 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': "Substring in the post text or the author's name."}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'anyOf': {'type': 'array', 'items': {'type': 'object', 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': "Substring in the post text or the author's name."}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'Only mentions in this status: open, ignored, done.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only mentions carrying any of these intent or topic tags.'}, 'isReply': {'type': 'boolean', 'description': 'true: only replies and comments; false: only top-level posts.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never authors tagged with any of these.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings; every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of keywords in any of these groups (grp_...).'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'relevant': {'type': 'boolean', 'description': 'true: only mentions the classifier scored relevant; false: only the rest.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made; false: only the rest.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1).'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only posts from any of these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of any of these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never mentions carrying these tags.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings; posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Only these sentiments.'}, 'notGroupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of keywords in these groups.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only matches of keywords of any of these kinds: brand, competitor, topic.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at most this many followers; unknown reach never passes.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers; unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Only mentions scored at least this.'}, 'notLanguages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Never posts in these languages; an unknown language still passes.'}, 'notLinkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never posts linking to these hosts.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Never posts from these platforms.'}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this.'}, 'notKeywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of these keywords.'}, 'notSentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Never these sentiments; an unscored mention still passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'description': 'A group of conditions, all of which must hold: the vocabulary of a view filter, without anyOf.', 'additionalProperties': False}, 'maxItems': 10, 'minItems': 1, 'description': 'OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'Only mentions in this status: open, ignored, done.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only mentions carrying any of these intent or topic tags.'}, 'isReply': {'type': 'boolean', 'description': 'true: only replies and comments; false: only top-level posts.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never authors tagged with any of these.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings; every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of keywords in any of these groups (grp_...).'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'relevant': {'type': 'boolean', 'description': 'true: only mentions the classifier scored relevant; false: only the rest.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made; false: only the rest.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1).'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only posts from any of these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of any of these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never mentions carrying these tags.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings; posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Only these sentiments.'}, 'notGroupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of keywords in these groups.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only matches of keywords of any of these kinds: brand, competitor, topic.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at most this many followers; unknown reach never passes.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers; unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Only mentions scored at least this.'}, 'notLanguages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Never posts in these languages; an unknown language still passes.'}, 'notLinkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never posts linking to these hosts.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Never posts from these platforms.'}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this.'}, 'notKeywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of these keywords.'}, 'notSentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Never these sentiments; an unscored mention still passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'description': 'The filter; empty selects every mention.', 'additionalProperties': False}, 'description': {'type': 'string', 'default': '', 'maxLength': 500, 'description': 'What the view is for, shown under its name.'}}, 'additionalProperties': False}
delete_activity
Delete activity
Delete an outreach activity logged by mistake. The person's owner and stage stay as they are.
Destruktiv
Eingabeschema
{'type': 'object', 'required': ['id', 'activityId'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Person id (aut_...)'}, 'activityId': {'type': 'string', 'minLength': 1, 'description': 'Activity id (act_...), from list_activities'}}, 'additionalProperties': False}
delete_alert
Delete alert
Delete an alert rule. Its channels stay and can serve other rules. Irreversible; disabling it (update_alert enabled=false) keeps the rule.
Destruktiv
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Alert id (feed_...)'}}, 'additionalProperties': False}
delete_group
Delete group
Delete a keyword group and EVERY keyword in it (each as delete_keyword does: its mentions go with it). The default group cannot be deleted. Says how many keywords went.
Destruktiv
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Group id (grp_...)'}}, 'additionalProperties': False}
delete_keyword
Delete keyword
Stop tracking a keyword and delete its mentions (a post also matched by another keyword stays). Alert rules that named it stop naming it; a rule that named only this keyword is disabled rather than widened to every keyword. Irreversible; muting (update_keyword muted=true) keeps the mentions.
Destruktiv
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Keyword id (kw_...)'}}, 'additionalProperties': False}
delete_segment
Delete segment
Delete a saved segment. Nobody in it is affected.
Destruktiv
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Segment id (seg_...), from list_segments'}}, 'additionalProperties': False}
delete_view
Delete view
Delete a saved view. No mention is affected.
Destruktiv
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'View id (vw_...)'}}, 'additionalProperties': False}
dismiss_attention
Dismiss attention
Dismiss an attention item (att_... from list_attention): it leaves the open list and does not come back while its condition lasts.
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Attention item id (att_...)'}}, 'additionalProperties': False}
get_alert
Get alert
One alert rule by id: its filter, mode and schedule, channels and delivery stats.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Alert id (feed_...)'}}, 'additionalProperties': False}
get_analytics_breakdown
Get analytics breakdown
One table grouped by a dimension `by`: platform, keyword, sentiment, intent, status (open, ignored, done), hour (weekday and hour of day in timezone, for "when do people talk"), or person (who posted most, with followers). Each row has matched, relevant, share of the window in percent, a sentiment split and, with compare=true, the same group in the period right before. Same window parameters as get_analytics_summary. At most 50 groups, most matched first.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'required': ['by'], 'properties': {'by': {'enum': ['platform', 'keyword', 'sentiment', 'intent', 'status', 'hour', 'person', 'language'], 'type': 'string', 'description': 'The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one).'}, 'to': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'Last day, YYYY-MM-DD, inclusive, in `timezone`. Default today.'}, 'from': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'First day, YYYY-MM-DD, inclusive, in `timezone`.'}, 'range': {'enum': ['7d', '30d', '90d', '365d'], 'type': 'string', 'description': 'Preset window ending today. Ignored when from or to is given. Default 30d.'}, 'compare': {'type': 'boolean', 'description': 'true adds the period of the same length right before the window as `previous`.'}, 'timezone': {'type': 'string', 'maxLength': 64, 'description': "IANA zone the days are cut in (Europe/Madrid). Default UTC. One offset, the zone's at the end of the window, applies to the whole window."}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string'}, 'maxItems': 20, 'description': 'Only these platforms. Repeatable, or comma-separated; omit for every platform.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Only these keyword ids. Repeatable, or comma-separated; omit for every keyword.'}}, 'additionalProperties': False}
get_analytics_series
Get analytics series
Mentions over time: one point per day or week (bucket; default day up to 90 days) with matched, relevant and sentiment counts, as a single "total" series or split with by="platform" or by="keyword" (top 20, the rest as "other"). Same window parameters as get_analytics_summary; compare=true adds `previous`, the period right before, points aligned by index.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'by': {'enum': ['platform', 'keyword', 'sentiment'], 'type': 'string', 'description': 'Split into one series per platform, per keyword (the top 20 by matched, the rest folded into "other") or per sentiment (positive, neutral, negative, unclassified). Omit for one total series.'}, 'to': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'Last day, YYYY-MM-DD, inclusive, in `timezone`. Default today.'}, 'from': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'First day, YYYY-MM-DD, inclusive, in `timezone`.'}, 'range': {'enum': ['7d', '30d', '90d', '365d'], 'type': 'string', 'description': 'Preset window ending today. Ignored when from or to is given. Default 30d.'}, 'bucket': {'enum': ['hour', 'day', 'week', 'month'], 'type': 'string', 'description': 'Point granularity: hour (windows of at most 14 days), day, week (Monday start) or month. Default: day up to 90 days, week beyond.'}, 'compare': {'type': 'boolean', 'description': 'true adds the period of the same length right before the window as `previous`.'}, 'timezone': {'type': 'string', 'maxLength': 64, 'description': "IANA zone the days are cut in (Europe/Madrid). Default UTC. One offset, the zone's at the end of the window, applies to the whole window."}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string'}, 'maxItems': 20, 'description': 'Only these platforms. Repeatable, or comma-separated; omit for every platform.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Only these keyword ids. Repeatable, or comma-separated; omit for every keyword.'}}, 'additionalProperties': False}
get_analytics_summary
Get analytics summary
Headline counts for a window: matched and relevant mentions, distinct posts and people, sentiment split, buying intent and questions, estimated reach (followers of the people whose count is known), and triage (open, ignored, done, waiting over 24h, handled rate, median time to done). Window: range 7d|30d|90d|365d ending today, or from/to as YYYY-MM-DD; keywordIds and platforms are lists; timezone (IANA) cuts the days, UTC by default; compare=true adds the same counts for the period right before as `previous`. Time axis is the publish date.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'to': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'Last day, YYYY-MM-DD, inclusive, in `timezone`. Default today.'}, 'from': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'First day, YYYY-MM-DD, inclusive, in `timezone`.'}, 'range': {'enum': ['7d', '30d', '90d', '365d'], 'type': 'string', 'description': 'Preset window ending today. Ignored when from or to is given. Default 30d.'}, 'compare': {'type': 'boolean', 'description': 'true adds the period of the same length right before the window as `previous`.'}, 'timezone': {'type': 'string', 'maxLength': 64, 'description': "IANA zone the days are cut in (Europe/Madrid). Default UTC. One offset, the zone's at the end of the window, applies to the whole window."}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string'}, 'maxItems': 20, 'description': 'Only these platforms. Repeatable, or comma-separated; omit for every platform.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Only these keyword ids. Repeatable, or comma-separated; omit for every keyword.'}}, 'additionalProperties': False}
get_company
Get company
Read what the classifier knows about the company: name, description, use cases, own accounts, and the composed context it reads to judge relevance (for keywords in a group that carries its own description, the group's text replaces it; see list_groups).
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
get_filters
Get filters
The workspace filters: noise rules applied to every keyword before a mention is stored (excluded terms and authors, excluded GitHub repositories, the subreddits Reddit posts may or may not come from). A post they reject is never classified, delivered or billed. Per-keyword rules live on each keyword (`matching`).
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
get_group
Get group
One keyword group by id, with how many keywords it holds.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Group id (grp_...)'}}, 'additionalProperties': False}
get_keyword
Get keyword
One keyword by id: term, kind, platforms, matching rules, context, its monthly mention cap and whether it is at it (pausedForCap), stats (mentions, relevant, last 7 days, this month, your feedback) and poll health per platform.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Keyword id (kw_...)'}}, 'additionalProperties': False}
get_keyword_health
Get keyword health
Is a keyword worth what it costs, and what would fix it. Over a trailing window (range 7d, 30d or 90d; default 30d): a status (healthy; noisy = 20 or more scored matches and under 30% relevant; quiet = 7 days or older with nothing relevant; capped; paused; new = under 7 days old) with reasons in plain words, matches, relevant, noise share by platform and week, what it cost, the words and authors over-represented in its noise, and suggestions. Each suggestion has a `patch`: pass it to update_keyword with the keyword id to apply it (lists hold the whole new list), and an `effect` measured by running the matcher's rules over the window's posts (noise and relevant matches it would have removed, cents saved). ai=true adds a context rewritten by a language model (cached a day; 20 model calls an hour per workspace). Read only, never billed, cached 5 minutes.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'ai': {'type': 'boolean', 'description': 'true: also ask a language model for a rewritten context. Default false.'}, 'id': {'type': 'string', 'minLength': 1, 'description': 'Keyword id (kw_...)'}, 'range': {'enum': ['7d', '30d', '90d'], 'type': 'string', 'description': 'Trailing window ending today: 7d, 30d (default) or 90d.'}}, 'additionalProperties': False}
get_mention
Get mention
Fetch a single mention by id, including its classification (relevance, sentiment, intents, confidence, uncertain, note).
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Mention id (mention match id, mm_...)'}}, 'additionalProperties': False}
get_mention_stats
Get mention stats
Mention counts for the last N days (default 7), grouped by platform and by sentiment, optionally filtered to one platform or keyword. Unclassified mentions appear under sentiment "unclassified".
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'platform': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Only count mentions from this platform'}, 'keywordId': {'type': 'string', 'description': 'Only count mentions matching this keyword id'}, 'sinceDays': {'type': 'integer', 'default': 7, 'maximum': 365, 'minimum': 1, 'description': 'Look-back window in days'}}, 'additionalProperties': False}
get_person
Get person
One person from the audience, with their counts, tags, notes and mute for your organization, their outreach (owner, stage, last contacted), plus their public profile (bio, company, location, website and linked accounts) where the platform lists it. GitHub authors are looked up today; profile is null until then. Email addresses are not returned over MCP: profile.email is always null (the dashboard and the REST API show it where the person published it).
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': "Audience author id (aut_...), from list_people or a mention's authorId"}}, 'additionalProperties': False}
get_reviews_report
Get reviews report
The reviews report: App Store, Google Play, Trustpilot and Google reviews the keywords collect, over a window. Totals (reviews, average stars, 1-5 distribution, replies, open 1-2 star reviews), the tags on the unhappy reviews, and one row per review page with its average stars per day or week (bucket). A review matched by two keywords counts once. Same window parameters as get_analytics_summary; compare=true adds the previous period.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'to': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'Last day, YYYY-MM-DD, inclusive, in `timezone`. Default today.'}, 'from': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'First day, YYYY-MM-DD, inclusive, in `timezone`.'}, 'range': {'enum': ['7d', '30d', '90d', '365d'], 'type': 'string', 'description': 'Preset window ending today. Ignored when from or to is given. Default 30d.'}, 'bucket': {'enum': ['day', 'week'], 'type': 'string', 'description': 'Series bucket: day (default up to 90 days) or week.'}, 'compare': {'type': 'boolean', 'description': 'true adds the period of the same length right before the window as `previous`.'}, 'timezone': {'type': 'string', 'maxLength': 64, 'description': "IANA zone the days are cut in (Europe/Madrid). Default UTC. One offset, the zone's at the end of the window, applies to the whole window."}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string'}, 'maxItems': 20, 'description': 'Only these platforms. Repeatable, or comma-separated; omit for every platform.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Only these keyword ids. Repeatable, or comma-separated; omit for every keyword.'}}, 'additionalProperties': False}
get_share_of_voice
Get share of voice
Brand against competitors: every keyword matched in the window with matched, relevant, negative and buy-intent counts and its share of brand plus competitor matches in percent (topics are counted but stay out of the split). Same window parameters as get_analytics_summary; compare=true adds the previous period's matched per keyword.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'to': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'Last day, YYYY-MM-DD, inclusive, in `timezone`. Default today.'}, 'from': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'First day, YYYY-MM-DD, inclusive, in `timezone`.'}, 'range': {'enum': ['7d', '30d', '90d', '365d'], 'type': 'string', 'description': 'Preset window ending today. Ignored when from or to is given. Default 30d.'}, 'compare': {'type': 'boolean', 'description': 'true adds the period of the same length right before the window as `previous`.'}, 'timezone': {'type': 'string', 'maxLength': 64, 'description': "IANA zone the days are cut in (Europe/Madrid). Default UTC. One offset, the zone's at the end of the window, applies to the whole window."}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string'}, 'maxItems': 20, 'description': 'Only these platforms. Repeatable, or comma-separated; omit for every platform.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Only these keyword ids. Repeatable, or comma-separated; omit for every keyword.'}}, 'additionalProperties': False}
get_usage
Get usage
The prepaid balance (ledger, pending mention charges, effective), the daily burn and the days it buys, how many keywords run and how many the wallet paused, the matches recorded today and over 30 days, and whether tracking is stopped or the balance is low. Every matched mention bills $0.008 and every active keyword $5 a month, charged daily.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
get_usage_breakdown
Get usage breakdown
What the workspace consumed and was charged over a window, in USD cents at list price, grouped by ONE dimension per call: `by` = keyword (the default: days charged, mentions billed, totalCents per keyword, a deleted keyword kept with keyword.removed=true), platform, or day. `range` (7d, 30d, 90d; default 30d) reads a trailing window ending today; `month` (YYYY-MM) reads one calendar month, the shape a bill or a per-customer margin is reconciled against. Every call also returns the window's totals (keyword-days, matched and billed mentions, list-price total, what the ledger actually debited). Rows are paged (limit, offset, total). Answer "what did keyword X cost" and "where does the money go" from it; get_usage answers "how much is left". Each keyword's running-month cost is also on get_keyword as stats.cost.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'by': {'enum': ['day', 'platform', 'keyword', 'group'], 'type': 'string', 'default': 'keyword', 'description': 'The dimension to group by: day (one row per UTC day of the window), platform, keyword (default: the row a margin is computed from), or group (what a customer or a campaign cost).'}, 'limit': {'type': 'integer', 'default': 100, 'maximum': 500, 'minimum': 1, 'description': 'Rows per page, 1 to 500 (default 100). Only by=keyword can outgrow a page; a window has at most 90 days and a dozen platforms.'}, 'month': {'type': 'string', 'pattern': '^\\d{4}-(0[1-9]|1[0-2])$', 'description': 'A calendar month (YYYY-MM, UTC) instead of a trailing window: from its first day to its last, or to today for the running month. A future month is a 400.'}, 'range': {'enum': ['7d', '30d', '90d'], 'type': 'string', 'description': 'Trailing window of UTC days ending today: 7d, 30d, 90d (default 30d). Ignored when `month` is given.'}, 'offset': {'type': 'integer', 'default': 0, 'minimum': 0, 'description': 'Skip this many rows.'}}, 'additionalProperties': False}
list_activities
List activities
The outreach log on one person, newest first: every logged contact with who reached out, the channel (email, x, linkedin, bluesky, reddit, github, call, meeting, other), when, and a short note. Check it, and the person's outreach owner, before reaching out so two teammates never contact the same person without knowing.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': "Audience author id (aut_...), from list_people or a mention's authorId"}}, 'additionalProperties': False}
list_alerts
List alerts
List alert rules: what each watches (filter), whether it fires instantly or as an hourly, daily or weekly digest (mode, schedule), and which channels it sends to.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_attention
List attention
What needs a person right now, newest first: a keyword whose mentions spiked in the last hour (mention.spike), whose negative share of the last 24 hours jumped (sentiment.negative_spike), that turned noisy (keyword.noisy), or a channel whose last sends all failed (channel.failing). Detected once an hour; items resolve on their own when the condition is gone. Open items by default; status "all" reads the history. Each item has a one-line title, the facts in data, and data.url pointing at the dashboard.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'kinds': {'type': 'array', 'items': {'enum': ['mention.spike', 'sentiment.negative_spike', 'keyword.noisy', 'channel.failing'], 'type': 'string', 'description': "mention.spike: far more mentions in the last hour than the keyword usually gets. sentiment.negative_spike: the negative share of the last 24 hours jumped. keyword.noisy: most scored matches are noise. channel.failing: the channel's last sends all failed."}, 'maxItems': 4, 'description': 'Only these kinds.'}, 'limit': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Items to return, 50 by default.'}, 'cursor': {'type': 'string', 'description': 'nextCursor from the previous call.'}, 'status': {'enum': ['open', 'resolved', 'dismissed', 'all'], 'type': 'string', 'description': 'open (default), resolved, dismissed, or all.'}}, 'additionalProperties': False}
list_channels
List channels
List the channels alerts can be sent to: Slack channels, Telegram chats, email address lists, webhooks. Telegram chats connect from the dashboard (Settings, Integrations), not through the API.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_groups
List groups
The keyword groups of the workspace, the default first: how keywords are grouped (a customer, a campaign, a product). A term may be tracked once per group; every keyword belongs to one; get_usage_breakdown by=group says what each cost. externalId finds the group carrying your own id.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'externalId': {'type': 'string', 'maxLength': 128, 'minLength': 1, 'description': 'Only the group carrying exactly this externalId.'}}, 'additionalProperties': False}
list_keywords
List keywords
The tracked keywords of your organization with their stats, poll health, matching rules and context, plus `total`. Without arguments: every keyword, newest first. Search the term and context (q), narrow by kind, status (active, muted by a person, paused by the wallet, noisy: paused by the noise brake, capped at its monthly mention cap), platform or group (groupId), order (sort) and page (limit, offset).
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': "Text to find in the term or in the keyword's context, case-insensitive."}, 'kind': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only these kinds: brand, competitor, topic. Repeatable, or comma-separated.'}, 'sort': {'enum': ['newest', 'oldest', 'term', 'mentions', 'relevant', 'recent', 'lastMention'], 'type': 'string', 'default': 'newest', 'description': 'newest: created most recently first. oldest: the reverse. term: A to Z. mentions: most matches first. relevant: most relevant matches first. recent: most matches in the last 7 days first. lastMention: newest matched post first, keywords with none last.'}, 'limit': {'type': 'integer', 'maximum': 500, 'minimum': 1, 'description': 'Page size, 1 to 500. Omit for every keyword after `offset`.'}, 'offset': {'type': 'integer', 'default': 0, 'minimum': 0, 'description': 'Skip this many keywords.'}, 'status': {'type': 'array', 'items': {'enum': ['active', 'muted', 'paused', 'noisy', 'capped'], 'type': 'string', 'description': 'active: tracking. muted: switched off by a person. paused: switched off by the wallet for lack of balance. noisy: switched off by the noise brake, mostly irrelevant matches on a workspace running on its welcome credit. capped: at its monthly mention cap until the month turns.'}, 'maxItems': 4, 'description': 'Only keywords in these states: active, muted, paused, capped. Repeatable, or comma-separated.'}, 'groupId': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Only keywords in any of these groups (grp_...). Repeatable, or comma-separated.'}, 'platform': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only keywords tracked on any of these platforms: its term searched there (every platform when its platforms are null), or for appstore and googleplay, an app of that store among its reviewSources. Repeatable, or comma-separated.'}}, 'additionalProperties': False}
list_ledger
List ledger
Every movement of the prepaid balance, newest first: the welcome credit, top-ups, refunds, the daily keyword-day and mention debits, adjustments. A debit row carries the UTC day it settled and the cumulative units behind it. Cursor paged (limit up to 100). Adding funds is a checkout on the dashboard's billing page or POST /v1/billing/top-ups on the REST API.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Page size (default 25).'}, 'cursor': {'type': 'string', 'description': 'Opaque cursor from a previous page.'}}, 'additionalProperties': False}
list_members
List members
The people in the workspace with their role (owner, admin, member), email and user id. The user id is the value update_mention assigneeId and update_person ownerId take.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_people
List people
The people who wrote mentions matching your keywords: name, profile, platform, how many of their posts matched (and how many scored relevant), their sentiment split, when they were first and last seen, and where your outreach stands (owner, stage, last contacted). Filter by platform or name, find one person by handle or profile link (handle), outreach stage (stages), owner (ownerIds, "none" for unowned) or automated (bot accounts, whose posts mostly read machine-made); sort by mentions or recency. Use search_mentions with authorId to read what one person said. Email addresses are not returned over MCP: profile.email is always null (the dashboard and the REST API show it where the person published it).
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'Match the display name or the profile handle/url'}, 'tag': {'type': 'string', 'maxLength': 40, 'minLength': 1, 'description': 'Only people carrying this tag'}, 'sort': {'enum': ['mentions', 'recent', 'reach', 'new'], 'type': 'string', 'default': 'mentions', 'description': '"mentions": most matches first; "recent": last seen first; "reach": most followers first; "new": first seen most recently first'}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'People carrying any of these tags'}, 'limit': {'type': 'integer', 'default': 50, 'maximum': 100, 'minimum': 1}, 'muted': {'type': 'boolean', 'description': 'true: only muted people; false: only unmuted; omit: everyone'}, 'since': {'type': 'integer', 'description': 'Only people whose first matched mention is at or after this instant (ISO 8601, or epoch ms): new voices'}, 'handle': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'Find one person by an account: a handle (@jane, u/jane) or a profile or post link (https://x.com/jane). Exact, case-insensitive; add platform to pick one platform'}, 'offset': {'type': 'integer', 'default': 0, 'minimum': 0, 'description': 'Skip this many people (paging)'}, 'stages': {'type': 'array', 'items': {'enum': ['not_contacted', 'contacted', 'replied', 'in_talks', 'customer', 'not_a_fit'], 'type': 'string', 'description': 'Where your workspace stands with the person: not_contacted, contacted, replied, in_talks, customer or not_a_fit.'}, 'maxItems': 6, 'description': 'People at any of these outreach stages (not_contacted, contacted, replied, in_talks, customer, not_a_fit)'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 10, 'description': 'At least one mention carrying any of these intents'}, 'ownerIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'People owned by any of these members (user ids); "none" for people nobody owns'}, 'platform': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Only people with an account on this platform'}, 'automated': {'type': 'boolean', 'description': 'true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'At least one mention linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com)'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string'}, 'maxItems': 20, 'description': 'People with an account on any of these platforms'}, 'segmentId': {'type': 'string', 'minLength': 1, 'description': 'A saved segment (from list_segments) applied on top of the other filters'}, 'minMentions': {'type': 'integer', 'minimum': 1, 'description': 'At least this many matched mentions'}, 'minNegative': {'type': 'integer', 'minimum': 1, 'description': 'At least this many negative mentions'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Mentioned a keyword of any of these kinds (brand, competitor, topic)'}, 'maxFollowers': {'type': 'integer', 'minimum': 0}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'At least this many followers (unknown reach never matches)'}, 'newSinceDays': {'type': 'integer', 'maximum': 365, 'minimum': 1, 'description': 'First seen within this many days'}, 'neverKeywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Never mentioned a keyword of these kinds'}}, 'additionalProperties': False}
list_segments
List segments
Your saved audience segments (named filters such as "Influencers" or "Switch prospects"), each with the number of people in it right now, plus presets you can save with create_segment. Pass a segment id to list_people to see its members.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_views
List views
Your saved views (named filters over mentions such as "Negative about us" or "Needs a reply"). Pass a view id as viewId to search_mentions to read exactly what it selects.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
log_activity
Log activity
Record that someone reached out to a person: an email, a DM, a call. The first contact claims an unowned person for whoever reached out and moves not_contacted to contacted; an existing owner and a later stage are kept (set them with update_person). memberId defaults to the signed-in user; with an API key and no memberId the activity is unattributed and claims nobody. Returns the activity and the person as they now read.
Eingabeschema
{'type': 'object', 'required': ['channel', 'id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': "Person id (aut_...), from list_people or a mention's authorId"}, 'note': {'type': 'string', 'default': '', 'maxLength': 2000, 'description': 'What was sent or said, briefly.'}, 'channel': {'enum': ['email', 'x', 'linkedin', 'bluesky', 'reddit', 'github', 'call', 'meeting', 'other'], 'type': 'string', 'description': 'How they were reached: email, x, linkedin, bluesky, reddit, github, call, meeting or other.'}, 'memberId': {'type': 'string', 'minLength': 1, 'description': 'The member who reached out (user id). Defaults to the signed-in member; an API key that omits it logs an unattributed activity.'}, 'occurredAt': {'type': 'integer', 'description': 'When the contact happened (ISO 8601, or epoch ms). Defaults to now.'}}, 'additionalProperties': False}
merge_people
Merge people
Declare that two accounts are the same person, for your organization only: fold account `id` into person `into`. Their mentions, tags and notes combine; the folded account shows under the person's platforms.
Destruktiv
Eingabeschema
{'type': 'object', 'required': ['id', 'into'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'The account to fold in (aut_...)'}, 'into': {'type': 'string', 'minLength': 1, 'description': 'The person to fold it into (aut_...)'}}, 'additionalProperties': False}
mute_authors
Mute authors
Mute authors on an alert without touching the rest of its filter. Accepts profile or post links, @handles, u/names, Bluesky DIDs or display names; a link is stored as the author's profile. Already muted authors are skipped; an entry that names no person is rejected.
Idempotent
Eingabeschema
{'type': 'object', 'required': ['authors', 'id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Rule id'}, 'authors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 500, 'minLength': 1}, 'maxItems': 50, 'minItems': 1, 'description': "Profile or post links (x.com/name, linkedin.com/in/name, reddit.com/user/name, a post URL), handles (@name, u/name), Bluesky DIDs or display names. A link is stored as the author's profile; a plain name or handle matches that name on every platform."}}, 'description': "Authors to add to or remove from the alert's muted list.", 'additionalProperties': False}
search_mentions
Search mentions
Search tracked mentions for your organization. Filter by keyword, platform, status (open, ignored, done), relevant, minimum relevance, minimum confidence (0 to 1), sentiment, intent, free text (q, the post text or the author name), time range (ISO 8601), one person (personId from list_people), assignee (assigneeId), author reach (minFollowers, maxFollowers), engagement the platform reported (minLikes, minReposts, minReplies, minQuotes, minViews, minBookmarks; a post without the count never passes), review stars (ratings, or notRatings to leave some out), author tags (tags, any-of), the hosts a post links to (linkHosts, any-of, a host or any subdomain of it), replies against top-level posts (isReply), whether the post reads as machine-made (automated=true for the bots, false for the rest), an alert rule's whole filter (alertId, the same mentions the rule would send), a saved view's filter (viewId, from list_views, ANDed with the rest), the kind of keyword that matched (keywordKinds: brand, competitor, topic), or the keyword's group (groupIds, or notGroupIds to leave groups out; ids from list_groups). Every filter is ANDed; for OR, anyOf takes up to 10 groups of the same conditions (an object each, all its conditions ANDed) and keeps a mention when at least one group holds, on top of the rest: anyOf=[{platforms:["reddit"],sentiments:["negative"]},{intents:["buy_intent"]}]. Snoozed mentions are hidden unless snoozed=true. sort="newest" (default) or "priority" (attention score from relevance, author reach, intent and age, over the last 30 days of matches only; each mention carries it as `priority`). Returns 10 mentions by default (limit, up to 100). Each mention nests post, author, classification and triage.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'q': {'type': 'string', 'description': "Substring search in the post text or the author's name."}, 'sort': {'enum': ['newest', 'priority'], 'type': 'string', 'default': 'newest', 'description': 'newest: by match time, newest first. priority: by attention score, highest first; priority ranks the last 30 days of matches only, older ones stay reachable under newest. Cursors are specific to a sort.'}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.'}, 'anyOf': {'type': 'array', 'items': {'type': 'object', 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': "Substring in the post text or the author's name."}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'Only mentions in this status: open, ignored, done.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only mentions carrying any of these intent or topic tags.'}, 'isReply': {'type': 'boolean', 'description': 'true: only replies and comments; false: only top-level posts.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never authors tagged with any of these.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings; every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of keywords in any of these groups (grp_...).'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'relevant': {'type': 'boolean', 'description': 'true: only mentions the classifier scored relevant; false: only the rest.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made; false: only the rest.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1).'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only posts from any of these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of any of these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never mentions carrying these tags.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings; posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Only these sentiments.'}, 'notGroupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of keywords in these groups.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only matches of keywords of any of these kinds: brand, competitor, topic.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at most this many followers; unknown reach never passes.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers; unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Only mentions scored at least this.'}, 'notLanguages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Never posts in these languages; an unknown language still passes.'}, 'notLinkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never posts linking to these hosts.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Never posts from these platforms.'}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this.'}, 'notKeywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of these keywords.'}, 'notSentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Never these sentiments; an unscored mention still passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'description': 'A group of conditions, all of which must hold: the vocabulary of a view filter, without anyOf.', 'additionalProperties': False}, 'maxItems': 10, 'minItems': 1, 'description': 'OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.'}, 'limit': {'type': 'integer', 'default': 10, 'maximum': 100, 'minimum': 1, 'description': 'How many mentions to return, 1 to 100. Default 10: narrow the filters before asking for more.'}, 'since': {'type': 'integer', 'description': 'Only posts published at or after this instant (ISO 8601, or epoch ms).'}, 'until': {'type': 'integer', 'description': 'Only posts published at or before this instant (ISO 8601, or epoch ms).'}, 'intent': {'type': 'string', 'description': 'Only mentions carrying this intent or topic tag (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'Only mentions in this status. Omit for every status.'}, 'viewId': {'type': 'string', 'minLength': 1, 'description': "Apply a saved view's filter (an id from GET /v1/views) on top of the other filters, every condition ANDed: exactly what the view selects. Unknown ids are a 404."}, 'alertId': {'type': 'string', 'minLength': 1, 'description': "Apply an alert rule's filter (an id from GET /v1/alerts) on top of the other filters: the same mentions the rule would send, for a feed-shaped export or a preview. Unknown ids are a 404."}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only mentions carrying any of these intent or topic tags.'}, 'isReply': {'type': 'boolean', 'description': 'true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never authors your workspace tagged with any of these.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings (1 to 5): ratings=1,2 is the unhappy ones. Every other post fails it.'}, 'snoozed': {'type': 'boolean', 'description': 'true: only mentions currently snoozed. Otherwise snoozed mentions stay out until they wake.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of keywords in any of these groups (grp_...). Repeatable, or comma-separated.'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'personId': {'type': 'string', 'minLength': 1, 'description': 'Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.'}, 'platform': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Only posts from this platform.'}, 'relevant': {'type': 'boolean', 'description': 'true: only mentions the classifier scored relevant; false: only the rest (unclassified included).'}, 'automated': {'type': 'boolean', 'description': 'true: only mentions that read as machine-made (a bot account, a scheduled or templated post, AI-written text); false: only the rest, mentions judged before this existed included. Omitted: everything.'}, 'keywordId': {'type': 'string', 'description': 'Only matches of this keyword.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). Repeatable, or comma-separated.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only posts from any of these platforms.'}, 'sentiment': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Only this sentiment.'}, 'assigneeId': {'type': 'string', 'minLength': 1, 'description': 'Only mentions assigned to this workspace member (user id).'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of any of these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never mentions carrying these intent or topic tags.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Only these sentiments.'}, 'notGroupIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of keywords in these groups.'}, 'includeMuted': {'type': 'boolean', 'description': 'true: include mentions by people you muted, hidden by default.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at most this many followers. Unknown reach never passes.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers. Unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Only mentions scored at least this; unclassified ones are excluded.'}, 'notLanguages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Never posts in these languages. A post whose language is unknown still passes.'}, 'notLinkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never posts linking to these hosts, the host itself or a subdomain of it.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Never posts from these platforms.'}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this, 0 to 1. Mentions without a confidence are excluded.'}, 'notKeywordIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of these keywords.'}, 'notSentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Never these sentiments. A mention the classifier has not scored yet still passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.'}}, 'additionalProperties': False}
split_person
Split person
Undo a merge: the account becomes its own person again for your organization.
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': "Audience author id (aut_...), from list_people or a mention's authorId"}}, 'additionalProperties': False}
unmute_authors
Unmute authors
Unmute authors on an alert without touching the rest of its filter. Name each by the stored entry or any link to that profile or its posts; authors that are not muted are ignored.
Idempotent
Eingabeschema
{'type': 'object', 'required': ['authors', 'id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Rule id'}, 'authors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 500, 'minLength': 1}, 'maxItems': 50, 'minItems': 1, 'description': "Profile or post links (x.com/name, linkedin.com/in/name, reddit.com/user/name, a post URL), handles (@name, u/name), Bluesky DIDs or display names. A link is stored as the author's profile; a plain name or handle matches that name on every platform."}}, 'description': "Authors to add to or remove from the alert's muted list.", 'additionalProperties': False}
update_alert
Update alert
Change an alert: name, enabled, mode, schedule, filter (replaces the whole filter) or channelIds (replaces the whole list).
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Rule id'}, 'mode': {'enum': ['instant', 'hourly', 'daily', 'weekly'], 'type': 'string'}, 'name': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'event': {'anyOf': [{'type': 'string', 'pattern': '^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)*$', 'maxLength': 60}, {'type': 'null'}]}, 'filter': {'type': 'object', 'properties': {'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'anyOf': {'type': 'array', 'items': {'type': 'object', 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': "Substring in the post text or the author's name."}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'Only mentions in this status: open, ignored, done.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only mentions carrying any of these intent or topic tags.'}, 'isReply': {'type': 'boolean', 'description': 'true: only replies and comments; false: only top-level posts.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never authors tagged with any of these.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings; every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of keywords in any of these groups (grp_...).'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'relevant': {'type': 'boolean', 'description': 'true: only mentions the classifier scored relevant; false: only the rest.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made; false: only the rest.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1).'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only posts from any of these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of any of these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never mentions carrying these tags.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings; posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Only these sentiments.'}, 'notGroupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of keywords in these groups.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only matches of keywords of any of these kinds: brand, competitor, topic.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at most this many followers; unknown reach never passes.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers; unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Only mentions scored at least this.'}, 'notLanguages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Never posts in these languages; an unknown language still passes.'}, 'notLinkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never posts linking to these hosts.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Never posts from these platforms.'}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this.'}, 'notKeywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of these keywords.'}, 'notSentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Never these sentiments; an unscored mention still passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'description': 'A group of conditions, all of which must hold: the vocabulary of a view filter, without anyOf.', 'additionalProperties': False}, 'maxItems': 10, 'minItems': 1, 'description': 'OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.'}, 'intents': {'type': 'array', 'items': {'type': 'string'}, 'description': 'At least one of these intent or topic tags.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings (1 to 5): [1, 2] sends the unhappy ones. Every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Only keywords in these groups (grp_...): one rule per customer, say.'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'description': 'Only posts from these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Only these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings (1 to 5): [5] keeps the five star reviews out. Posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'description': 'Only these sentiments.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers. Unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': "The rule's relevance floor. Absent, it sends relevant mentions only (scored 40 and up, the classifier's line); lower, down to 0, it also receives the matches the classifier scored as noise; higher, it hears less. Email channels keep the 40 line whatever the rule says. Unclassified mentions never pass."}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this, 0 to 1. A mention without a confidence never passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'description': 'Replaces the whole filter.', 'additionalProperties': False}, 'enabled': {'type': 'boolean'}, 'schedule': {'anyOf': [{'type': 'object', 'required': ['hour', 'timezone'], 'properties': {'hour': {'type': 'integer', 'maximum': 23, 'minimum': 0}, 'minute': {'type': 'integer', 'default': 0, 'maximum': 59, 'minimum': 0}, 'weekday': {'type': 'integer', 'maximum': 6, 'minimum': 0, 'description': 'Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.'}, 'timezone': {'type': 'string', 'maxLength': 64, 'minLength': 1}, 'skipEmpty': {'type': 'boolean', 'default': True}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Daily and weekly alerts. Ignored on an hourly one, except a weekday, which is refused.'}, 'channelIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 20, 'description': 'Replaces the whole list.'}}, 'description': 'Omitted fields are untouched.', 'additionalProperties': False}
update_company
Update company
Update the company profile (name, description, useCases, accounts) or override the classifier context directly. Profile edits recompose the context; an explicit context wins until the next profile edit. The context is the single biggest lever on relevance scoring, so keep it accurate and specific; it does not reach keywords in a group with its own description (update_group for those). Omitted fields are untouched.
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'name': {'type': 'string', 'maxLength': 120, 'minLength': 1}, 'context': {'type': 'string', 'maxLength': 4000, 'description': 'Overrides the composed context until the next profile edit.'}, 'website': {'anyOf': [{'type': 'string', 'format': 'uri', 'maxLength': 300}, {'type': 'null'}], 'description': 'The company website; null clears it.'}, 'accounts': {'type': 'object', 'properties': {'x': {'anyOf': [{'type': 'string', 'maxLength': 60}, {'type': 'null'}]}, 'linkedin': {'anyOf': [{'type': 'string', 'maxLength': 200}, {'type': 'null'}]}}, 'additionalProperties': False}, 'useCases': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Replaces the whole list.'}, 'guidelines': {'anyOf': [{'type': 'string', 'maxLength': 2000}, {'type': 'null'}], 'description': 'Free-text rules for the classifier; null clears them.'}, 'competitors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 120, 'minLength': 1}, 'maxItems': 50, 'description': 'Replaces the whole list; [] clears it.'}, 'description': {'type': 'string', 'maxLength': 1000}}, 'description': 'Omitted fields are untouched.', 'additionalProperties': False}
update_filters
Update filters
Change the workspace filters: excludedTerms (a `*` at an end is a wildcard), excludedAuthors (links, handles, names), excludedRepos (owner/name or a github.com link), subreddits.only (an allowlist; when set, excluded is ignored) and subreddits.excluded. Each list optional; an omitted list is untouched, an empty one clears it. Takes effect on new mentions within a minute.
Idempotent
Eingabeschema
{'type': 'object', 'properties': {'subreddits': {'type': 'object', 'properties': {'only': {'type': 'array', 'items': {'type': 'string', 'maxLength': 100, 'minLength': 1}, 'maxItems': 200, 'description': 'Replaces the allowlist; [] clears it.'}, 'excluded': {'type': 'array', 'items': {'type': 'string', 'maxLength': 100, 'minLength': 1}, 'maxItems': 200, 'description': 'Replaces the deny list; [] clears it.'}}, 'description': 'Reddit only; an omitted list is untouched.', 'additionalProperties': False}, 'excludedRepos': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Replaces the list; [] clears it.'}, 'excludedTerms': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 200, 'description': 'Replaces the list; [] clears it.'}, 'excludedAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 500, 'minLength': 1}, 'maxItems': 200, 'description': 'Replaces the list; [] clears it.'}}, 'description': 'Omitted fields are untouched; an empty list clears one.', 'additionalProperties': False}
update_group
Update group
Rename a keyword group, change your id for it (externalId, null clears) or its company description (context, null clears: the workspace profile applies again; new mentions are judged with it at once). The default group can be renamed but takes no description: it is the workspace itself and reads the company profile (update_company).
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Group id (grp_...)'}, 'name': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': "The group's name: a customer, a campaign, a product. Unique per workspace."}, 'context': {'anyOf': [{'type': 'string', 'maxLength': 4000, 'description': 'What the classifier reads as "the company" for this group\'s keywords, in place of the WHOLE workspace profile, its relevance guidelines and competitor list included (at most 4000 characters): who the business is, what it sells, for whom, what is not it, and any rule that should apply to this group ("ignore job posts"). For a group per customer, the customer\'s description. Null: the workspace profile, as for every keyword before groups.'}, {'type': 'null'}], 'description': "Replaces the group's company description; null clears it (the workspace profile applies again). New mentions are judged with it at once; old ones are not rescored. Not on the default group (400 default_group_context): that one is the workspace itself and reads the profile."}, 'externalId': {'anyOf': [{'type': 'string', 'maxLength': 128, 'minLength': 1, 'description': 'Your own id for the group (a customer id, say). Unique per workspace; find the group by it with GET /v1/groups?externalId=.'}, {'type': 'null'}], 'description': 'Replaces your id for the group; null clears it.'}}, 'description': 'Omitted fields are untouched.', 'additionalProperties': False}
update_keyword
Update keyword
Change a keyword: the platforms it is tracked on (platforms: a list, or null for every platform), mute or unmute it, reclassify it (kind), set its classifier context (null clears), or its matching rules (matching: each field optional, an empty list clears one; requiredTerms with requiredMode any|all, excludedTerms with a `*` wildcard at an end, excludedAuthors, caseSensitive), or its monthly mention cap (cap: { mentions: N }, null removes it; a cap above this month's count resumes a capped keyword at once), or move it to another group (groupId; a 409 when that group already tracks the term), or replace where it collects reviews, App Store, Google Play, Trustpilot or Google Maps (reviewSources: the whole list, [] disconnects them; a newly added app or country brings its last 30 days free). Rules apply to new mentions only. Returns the updated keyword with its stats.
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Keyword id'}, 'cap': {'anyOf': [{'type': 'object', 'required': ['mentions'], 'properties': {'mentions': {'type': 'integer', 'maximum': 1000000, 'minimum': 1, 'description': 'Matched mentions allowed per calendar month (UTC). Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.'}}, 'description': 'A monthly ceiling on the mentions this keyword may match. At the cap it stops matching until the first of the next month (UTC), or until the cap is raised or removed. It stays unmuted: it keeps its place and its daily keyword charge; pause it to stop that too.', 'additionalProperties': False}, {'type': 'null'}], 'description': "Replaces the monthly mention cap; null removes it. A cap above this month's count resumes a capped keyword at once, one at or under it pauses it."}, 'kind': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string', 'description': 'Reclassify it as brand, competitor or topic.'}, 'muted': {'type': 'boolean', 'description': 'A muted keyword stops polling and matching; its mentions stay.'}, 'context': {'anyOf': [{'type': 'string', 'maxLength': 300, 'description': 'A sentence the classifier reads for this keyword only, on top of the company profile or the group\'s own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.'}, {'type': 'null'}], 'description': 'A sentence the classifier reads for this keyword only, on top of the company profile or the group\'s own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.'}, 'groupId': {'type': 'string', 'minLength': 1, 'description': 'Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.'}, 'matching': {'type': 'object', 'properties': {'requiredMode': {'enum': ['any', 'all'], 'type': 'string', 'description': 'any: at least one required term must appear. all: every one must.'}, 'caseSensitive': {'type': 'boolean', 'description': 'true: the term must appear in the case it was typed (RAG, never rag). Default false.'}, 'excludedTerms': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 50, 'description': 'A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).'}, 'requiredTerms': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'maxItems': 50, 'description': 'The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.'}, 'excludedAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 500, 'minLength': 1}, 'maxItems': 100, 'description': "Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list."}}, 'description': 'Omitted fields are untouched; an empty list clears one.', 'additionalProperties': False}, 'platforms': {'anyOf': [{'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram'], 'type': 'string'}}, {'type': 'null'}], 'description': 'Replaces the platform list; null means every platform, [] none (reviews only, when the keyword has reviewSources).'}, 'reviewSources': {'type': 'array', 'items': {'type': 'object', 'properties': {'id': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'The id on the platform: the digits after "id" on the App Store, the package name on Google Play, the company\'s domain on Trustpilot (notion.so), a Place ID (ChIJ...) on Google Maps.'}, 'url': {'type': 'string', 'maxLength': 500, 'minLength': 1, 'description': "The review page's link: an App Store or Google Play app (https://apps.apple.com/us/app/notion/id1232780281, https://play.google.com/store/apps/details?id=notion.id), a Trustpilot page (https://www.trustpilot.com/review/notion.so) or a Google Maps place (its full link, or a maps.app.goo.gl share link). Or give platform and id."}, 'language': {'type': 'string', 'maxLength': 10, 'minLength': 2, 'description': "Google Play only: the language of the reviews to read (en, es, de, pt-BR); Google Play answers one language at a time. Default: the link's hl, else en."}, 'platform': {'enum': ['appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': "appstore (Apple App Store), googleplay (Google Play), trustpilot (a company's Trustpilot page) or googlemaps (a place's Google reviews)."}, 'countries': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[A-Za-z]{2}$'}, 'maxItems': 20, 'minItems': 1, 'description': 'App Store and Google Play only: storefronts to read, two-letter codes, at most 20. Default: the one in the link, else us. Each is one more poll a day; the same review seen in two storefronts is one mention. Trustpilot and Google Maps have one page for everyone and take none.'}}, 'description': "A review page whose reviews become this keyword's mentions: its link, or the platform and the id.", 'additionalProperties': False}, 'maxItems': 10, 'description': 'Replaces the list of apps whose reviews this keyword collects; [] disconnects them all (their reviews stay). An app or country added here gets the free 30-day look-back; one already listed keeps its place.'}}, 'description': 'Omitted fields are untouched.', 'additionalProperties': False}
update_mention
Update mention
The one write on a mention: status "ignored" (not interesting) or "done" (handled), "open" to put it back; assign it to a workspace member (assigneeId, null to unassign); snooze it out of the feed until an ISO 8601 instant (snoozedUntil, null to wake it); leave an internal note (note, null to clear); or correct the classifier with `relevant` (true or false: your verdict, which sets relevance to 100 or 0 and moves the mention in or out of the relevant feed; null withdraws it) and `sentiment` (a corrected label; null restores the classifier's). Use the verdicts when the user says a mention is noise or was missed. Omitted fields are untouched. Delivery and billing never change.
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Mention id (mm_...)'}, 'note': {'anyOf': [{'type': 'string', 'maxLength': 2000}, {'type': 'null'}], 'description': 'Internal note; null or empty clears it.'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'ignored or done to handle it; open to put it back.'}, 'relevant': {'type': ['boolean', 'null'], 'description': "Your verdict on relevance, correcting the classifier: true sets relevance to 100 and puts a filtered mention back in the relevant feed, false sets it to 0 and takes it out; null withdraws the verdict and restores the classifier's score. Never billed or unbilled. A mention still being classified answers 409 classification_pending."}, 'sentiment': {'anyOf': [{'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, {'type': 'null'}], 'description': "Your corrected sentiment; null withdraws the correction and restores the classifier's."}, 'assigneeId': {'anyOf': [{'type': 'string', 'minLength': 1}, {'type': 'null'}], 'description': 'A workspace member (user id), or null to unassign.'}, 'snoozedUntil': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'description': 'ISO 8601 (or epoch ms) until which the mention leaves the feed; null wakes it.'}}, 'description': 'Every field is optional; omitted fields are untouched.', 'additionalProperties': False}
update_person
Update person
Annotate a person for your organization: replace their tags, set notes, mute/unmute them, or set the outreach owner (ownerId, a member user id; null clears) and stage. Muting hides their posts from the feed and from every channel; ingest and billing are unchanged.
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Audience author id (aut_...)'}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Replaces the whole list.'}, 'muted': {'type': 'boolean'}, 'notes': {'type': 'string', 'maxLength': 2000}, 'stage': {'enum': ['not_contacted', 'contacted', 'replied', 'in_talks', 'customer', 'not_a_fit'], 'type': 'string', 'description': 'Where your workspace stands with the person: not_contacted, contacted, replied, in_talks, customer or not_a_fit.'}, 'ownerId': {'anyOf': [{'type': 'string', 'minLength': 1}, {'type': 'null'}], 'description': 'The member who owns the contact (user id); null clears.'}}, 'description': 'Omitted fields are untouched.', 'additionalProperties': False}
update_segment
Update segment
Rename, describe or refilter a saved segment. `filter` replaces the whole filter.
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Segment id (seg_...)'}, 'name': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'filter': {'type': 'object', 'properties': {'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'People carrying any of these tags.'}, 'muted': {'type': 'boolean', 'description': 'true: only muted people; false: only unmuted.'}, 'stages': {'type': 'array', 'items': {'enum': ['not_contacted', 'contacted', 'replied', 'in_talks', 'customer', 'not_a_fit'], 'type': 'string', 'description': 'Where your workspace stands with the person: not_contacted, contacted, replied, in_talks, customer or not_a_fit.'}, 'maxItems': 6, 'description': 'People at any of these outreach stages.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 10, 'description': 'At least one mention carrying any of these intents.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Nobody carrying any of these tags.'}, 'ownerIds': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'People owned by any of these members (user ids); "none" matches people nobody owns.'}, 'automated': {'type': 'boolean', 'description': 'true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'At least one mention linking to any of these hosts, the host itself or a subdomain of it.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'People with an account on any of these platforms.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 10, 'description': 'Nobody whose mentions carry any of these intents.'}, 'minMentions': {'type': 'integer', 'minimum': 1, 'description': 'At least this many matched mentions.'}, 'minNegative': {'type': 'integer', 'minimum': 1, 'description': 'At least this many negative mentions.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Mentioned a keyword of any of these kinds.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'At most this many followers. Unknown reach never matches.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'At least this many followers. Unknown reach never matches.'}, 'newSinceDays': {'type': 'integer', 'maximum': 365, 'minimum': 1, 'description': 'First seen within this many days.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Nobody with an account on these platforms.'}, 'neverKeywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Never mentioned a keyword of these kinds.'}}, 'description': 'Replaces the whole filter.', 'additionalProperties': False}, 'description': {'type': 'string', 'maxLength': 500}}, 'description': 'Omitted fields are untouched.', 'additionalProperties': False}
update_view
Update view
Rename, describe or refilter a saved view. `filter` replaces the whole filter.
Idempotent
Eingabeschema
{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'View id (vw_...)'}, 'name': {'type': 'string', 'maxLength': 80, 'minLength': 1}, 'filter': {'type': 'object', 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': "Substring in the post text or the author's name."}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'anyOf': {'type': 'array', 'items': {'type': 'object', 'properties': {'q': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': "Substring in the post text or the author's name."}, 'tags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only authors your workspace tagged with any of these.'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'Only mentions in this status: open, ignored, done.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only mentions carrying any of these intent or topic tags.'}, 'isReply': {'type': 'boolean', 'description': 'true: only replies and comments; false: only top-level posts.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never authors tagged with any of these.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings; every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of keywords in any of these groups (grp_...).'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'relevant': {'type': 'boolean', 'description': 'true: only mentions the classifier scored relevant; false: only the rest.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made; false: only the rest.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1).'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only posts from any of these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of any of these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never mentions carrying these tags.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings; posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Only these sentiments.'}, 'notGroupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of keywords in these groups.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only matches of keywords of any of these kinds: brand, competitor, topic.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at most this many followers; unknown reach never passes.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers; unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Only mentions scored at least this.'}, 'notLanguages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Never posts in these languages; an unknown language still passes.'}, 'notLinkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never posts linking to these hosts.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Never posts from these platforms.'}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this.'}, 'notKeywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of these keywords.'}, 'notSentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Never these sentiments; an unscored mention still passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'description': 'A group of conditions, all of which must hold: the vocabulary of a view filter, without anyOf.', 'additionalProperties': False}, 'maxItems': 10, 'minItems': 1, 'description': 'OR across groups: a mention passes when it meets every condition of at least one group (1 to 10 groups). The other conditions still apply to every mention: the whole filter is (other conditions) AND (group 1 OR group 2 ...). A group takes the conditions of a view filter (platforms, sentiments, intents, keywordKinds, the not lists ...), with no anyOf of its own.'}, 'status': {'enum': ['open', 'ignored', 'done'], 'type': 'string', 'description': 'Only mentions in this status: open, ignored, done.'}, 'intents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Only mentions carrying any of these intent or topic tags.'}, 'isReply': {'type': 'boolean', 'description': 'true: only replies and comments; false: only top-level posts.'}, 'notTags': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never authors tagged with any of these.'}, 'ratings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Only app store reviews with any of these star ratings; every other post fails it.'}, 'groupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of keywords in any of these groups (grp_...).'}, 'minLikes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minViews': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'relevant': {'type': 'boolean', 'description': 'true: only mentions the classifier scored relevant; false: only the rest.'}, 'automated': {'type': 'boolean', 'description': 'true: only posts that read as machine-made; false: only the rest.'}, 'languages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Only posts in any of these languages (ISO 639-1).'}, 'linkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Only posts linking to any of these hosts, the host itself or a subdomain of it.'}, 'minQuotes': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'platforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Only posts from any of these platforms.'}, 'keywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Only matches of any of these keywords.'}, 'minReplies': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minReposts': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'notIntents': {'type': 'array', 'items': {'type': 'string', 'maxLength': 40, 'minLength': 1}, 'maxItems': 20, 'description': 'Never mentions carrying these tags.'}, 'notRatings': {'type': 'array', 'items': {'type': 'integer', 'maximum': 5, 'minimum': 1}, 'maxItems': 5, 'description': 'Never reviews with these star ratings; posts that are not reviews still pass.'}, 'sentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Only these sentiments.'}, 'notGroupIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of keywords in these groups.'}, 'keywordKinds': {'type': 'array', 'items': {'enum': ['brand', 'competitor', 'topic'], 'type': 'string'}, 'maxItems': 3, 'description': 'Only matches of keywords of any of these kinds: brand, competitor, topic.'}, 'maxFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at most this many followers; unknown reach never passes.'}, 'minBookmarks': {'type': 'integer', 'minimum': 0, 'description': '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.'}, 'minFollowers': {'type': 'integer', 'minimum': 0, 'description': 'Only authors with at least this many followers; unknown reach never passes.'}, 'minRelevance': {'type': 'integer', 'maximum': 100, 'minimum': 0, 'description': 'Only mentions scored at least this.'}, 'notLanguages': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z]{2}$'}, 'maxItems': 20, 'description': 'Never posts in these languages; an unknown language still passes.'}, 'notLinkHosts': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 20, 'description': 'Never posts linking to these hosts.'}, 'notPlatforms': {'type': 'array', 'items': {'enum': ['bluesky', 'hackernews', 'github', 'stackoverflow', 'devto', 'reddit', 'x', 'youtube', 'news', 'linkedin', 'tiktok', 'instagram', 'appstore', 'googleplay', 'trustpilot', 'googlemaps'], 'type': 'string', 'description': 'Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place).'}, 'maxItems': 20, 'description': 'Never posts from these platforms.'}, 'minConfidence': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Only mentions whose classifier confidence is at least this.'}, 'notKeywordIds': {'type': 'array', 'items': {'type': 'string', 'minLength': 1}, 'maxItems': 50, 'description': 'Never matches of these keywords.'}, 'notSentiments': {'type': 'array', 'items': {'enum': ['positive', 'neutral', 'negative'], 'type': 'string', 'description': 'Classifier sentiment.'}, 'maxItems': 3, 'description': 'Never these sentiments; an unscored mention still passes.'}, 'excludeAuthors': {'type': 'array', 'items': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'maxItems': 200, 'description': 'Never these authors: display names, handles or profile URLs.'}}, 'description': 'Replaces the whole filter.', 'additionalProperties': False}, 'description': {'type': 'string', 'maxLength': 500}}, 'additionalProperties': False}
whoami
Whoami
The workspace this credential acts on, how it authenticated (an API key or an OAuth sign-in), whether it may write, and the person behind it when there is one. Call it once at the start of a session to name the workspace and know whether write tools are available.
Nur Lesen
Idempotent
Eingabeschema
{'type': 'object', 'properties': {}, 'additionalProperties': False}
Verlauf
Letzte Tool-Änderungen
Hinzugefügt
get_mention_stats
5. October 2026 02:40
Hinzugefügt
delete_activity
5. October 2026 02:40
Hinzugefügt
log_activity
5. October 2026 02:40
Hinzugefügt
list_activities
5. October 2026 02:40
Hinzugefügt
split_person
5. October 2026 02:40
Hinzugefügt
merge_people
5. October 2026 02:40
Hinzugefügt
update_person
5. October 2026 02:40
Hinzugefügt
get_person
5. October 2026 02:40
Hinzugefügt
list_people
5. October 2026 02:40
Hinzugefügt
update_company
5. October 2026 02:40
Hinzugefügt
get_company
5. October 2026 02:40
Hinzugefügt
update_filters
5. October 2026 02:40
Hinzugefügt
get_filters
5. October 2026 02:40
Hinzugefügt
list_ledger
5. October 2026 02:40
Hinzugefügt
get_usage_breakdown
5. October 2026 02:40
Hinzugefügt
get_usage
5. October 2026 02:40
Hinzugefügt
list_members
5. October 2026 02:40
Hinzugefügt
whoami
5. October 2026 02:40
Hinzugefügt
delete_keyword
5. October 2026 02:40
Hinzugefügt
get_keyword_health
5. October 2026 02:40
Hinzugefügt
get_keyword
5. October 2026 02:40
Hinzugefügt
list_keywords
5. October 2026 02:40
Hinzugefügt
unmute_authors
5. October 2026 02:40
Hinzugefügt
mute_authors
5. October 2026 02:40
Hinzugefügt
update_alert
5. October 2026 02:40
Hinzugefügt
create_alert
5. October 2026 02:40
Hinzugefügt
dismiss_attention
5. October 2026 02:40
Hinzugefügt
list_attention
5. October 2026 02:40
Hinzugefügt
list_channels
5. October 2026 02:40
Hinzugefügt
delete_alert
5. October 2026 02:40
Entdecken
Ähnliche MCP-Server
LinkedIn MCP Server (Salesbot)
cz.salesbot/linkedin-mcp-server
Supports LinkedIn lead discovery, contact enrichment, CRM pipelines, campaign sequencing, message approval and human-reviewed out…
linkedin-buying-signals
com.getcleed/linkedin-buying-signals
Finds and analyzes LinkedIn prospects with buying signals, manages lead records and drafts or sends personalized email and Linked…
OpenComment AI
io.github.02inf/opencomment-ai
Provides product information for researching LinkedIn contacts, monitoring activity, and preparing engagement campaigns.
Pro Reach LinkedIn Outreach
ai.proreach/outreach
Supports planning and managing LinkedIn outreach, including templates, leads, confirmation-gated launches, metrics, and replies.
mcp-creator-lead-list-all-in-one
com.mambabuilt/mcp-creator-lead-list-all-in-one
Builds influencer lead lists from keywords or handles, including contact details.
RedReplier
com.redreplier/mcp-server
Monitors mentions across Reddit, Hacker News, X, and Bluesky and triages potential leads.
Zevari
ai.zevari/mcp
Supports review-gated LinkedIn prospecting and go-to-market outreach workflows.
neuron
io.github.conquext/neuron
Operates AI chatbots and messaging workflows across WhatsApp and social channels, including contacts, campaigns, conversations, p…