Rumoro

Official55 tools

by rumoro-dev

Track what people say about your product on Reddit, X, Hacker News, GitHub and more

dev.rumoro/mcp MCP Server

The dev.rumoro/mcp Model Context Protocol (MCP) server tracks what people say about a product across multiple platforms. Its description indicates monitoring discussions on Reddit, X, Hacker News, and GitHub, consolidating public commentary into a format accessible via MCP.

🛠️ Key Features

Tracks product mentions and discussion across Reddit, X, Hacker News, and GitHub
Uses MCP to expose the gathered tracking data

🚀 Use Cases

Monitor public sentiment and feedback for a product
Track how conversations evolve across major developer and general platforms

⚡ Developer Benefits

Centralizes multi-source discussion tracking in an MCP-accessible service
Provides a structured way to retrieve platform-specific commentary

⚠️ Limitations

Source information does not specify available tools, authentication, or update frequency

Topics

ai-agentsbrand-monitoringclaudecursormcpmcp-servermodel-context-protocolsocial-listeningrumoro

Captured live from the server via tools/list.

list_segments

Lists your saved audience segments, which are named people filters such as "Large accounts" or "Open to switching", with the current number of people in each. Also returns presets you can save with create_segment. To see who is in a segment, pass its id to list_people.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

create_segment

Saves an audience segment with a name and a filter. The filter can use platforms, tags, follower range, minimum mentions or negative mentions, intents, keyword kinds the person did or did not mention, first seen within N days, and linkHosts they linked to. Members are worked out on each read, not stored.

Parameters3

name	string	required
description	string	optional
filter	object	optional

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "description": {
      "type": "string",
      "maxLength": 500,
      "default": ""
    },
    "filter": {
      "type": "object",
      "properties": {
        "platforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "maxItems": 20,
          "description": "Only people with a profile on one of these platforms."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "People with one of these tags."
        },
        "minFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "This many followers or more. People with an unknown count are left out."
        },
        "maxFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "This many followers or fewer. People with an unknown count are left out."
        },
        "minMentions": {
          "type": "integer",
          "minimum": 1,
          "description": "Minimum number of matched mentions."
        },
        "minNegative": {
          "type": "integer",
          "minimum": 1,
          "description": "Minimum number of negative mentions."
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 10,
          "description": "Has a mention tagged with one of these intents."
        },
        "keywordKinds": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "brand",
              "competitor",
              "topic"
            ]
          },
          "maxItems": 3,
          "description": "Only people with a mention of these keyword kinds."
        },
        "neverKeywordKinds": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "brand",
              "competitor",
              "topic"
            ]
          },
          "maxItems": 3,
          "description": "Excludes people who mentioned these keyword kinds."
        },
        "notPlatforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "maxItems": 20,
          "description": "Leaves out people who have an account on these platforms."
        },
        "notTags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Leaves out people with one of these tags."
        },
        "notIntents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 10,
          "description": "Excludes people with a mention of these intents."
        },
        "newSinceDays": {
          "type": "integer",
          "minimum": 1,
          "maximum": 365,
          "description": "People first seen in the past this many days."
        },
        "linkHosts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "People with a mention that links to one of these hosts or its subdomains."
        },
        "muted": {
          "type": "boolean",
          "description": "true keeps only muted people and false only people who are not muted."
        },
        "stages": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "not_contacted",
              "contacted",
              "replied",
              "in_talks",
              "customer",
              "not_a_fit"
            ],
            "description": "The outreach stage your team has reached with this person."
          },
          "maxItems": 6,
          "description": "Only people in one of these outreach stages."
        },
        "automated": {
          "type": "boolean",
          "description": "true keeps people whose matched posts are mostly automated, like bots. false keeps the rest."
        },
        "ownerIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "People owned by one of these members, by user id. Use \"none\" for people without an owner."
        }
      },
      "additionalProperties": false,
      "default": {}
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

update_segment

Changes a saved segment's name, description or filter. `filter` sets the full new filter.

Parameters4

name	string	optional
description	string	optional
filter	object	optional	Sets the full new filter.
id	string	required	The segment's id (seg_...)

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "description": {
      "type": "string",
      "maxLength": 500
    },
    "filter": {
      "type": "object",
      "properties": {
        "platforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "maxItems": 20,
          "description": "Only people with a profile on one of these platforms."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "People with one of these tags."
        },
        "minFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "This many followers or more. People with an unknown count are left out."
        },
        "maxFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "This many followers or fewer. People with an unknown count are left out."
        },
        "minMentions": {
          "type": "integer",
          "minimum": 1,
          "description": "Minimum number of matched mentions."
        },
        "minNegative": {
          "type": "integer",
          "minimum": 1,
          "description": "Minimum number of negative mentions."
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 10,
          "description": "Has a mention tagged with one of these intents."
        },
        "keywordKinds": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "brand",
              "competitor",
              "topic"
            ]
          },
          "maxItems": 3,
          "description": "Only people with a mention of these keyword kinds."
        },
        "neverKeywordKinds": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "brand",
              "competitor",
              "topic"
            ]
          },
          "maxItems": 3,
          "description": "Excludes people who mentioned these keyword kinds."
        },
        "notPlatforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "maxItems": 20,
          "description": "Leaves out people who have an account on these platforms."
        },
        "notTags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Leaves out people with one of these tags."
        },
        "notIntents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 10,
          "description": "Excludes people with a mention of these intents."
        },
        "newSinceDays": {
          "type": "integer",
          "minimum": 1,
          "maximum": 365,
          "description": "People first seen in the past this many days."
        },
        "linkHosts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "People with a mention that links to one of these hosts or its subdomains."
        },
        "muted": {
          "type": "boolean",
          "description": "true keeps only muted people and false only people who are not muted."
        },
        "stages": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "not_contacted",
              "contacted",
              "replied",
              "in_talks",
              "customer",
              "not_a_fit"
            ],
            "description": "The outreach stage your team has reached with this person."
          },
          "maxItems": 6,
          "description": "Only people in one of these outreach stages."
        },
        "automated": {
          "type": "boolean",
          "description": "true keeps people whose matched posts are mostly automated, like bots. false keeps the rest."
        },
        "ownerIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "People owned by one of these members, by user id. Use \"none\" for people without an owner."
        }
      },
      "additionalProperties": false,
      "description": "Sets the full new filter."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The segment's id (seg_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "description": "Fields you leave out stay as they are."
}

delete_segment

Deletes a saved segment. The people in it are not changed.

Parameters1

string

required

The segment's id (seg_...) from list_segments

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The segment's id (seg_...) from list_segments"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

list_views

Lists your saved views, which are named mention filters such as "Bug reports" or "Waiting on us". Pass a view's id as viewId to search_mentions to get exactly what it shows.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

create_view

Saves a view with a name and a filter. The filter uses the fields of search_mentions, such as keywords or keyword kinds, platforms, status, relevant, sentiments, intents, languages, author tags, follower range, replies, link hosts, automated and free text. A list matches any value, a `not` list matches none, and all conditions are joined by AND. anyOf adds OR with groups of such conditions, at least one of which must match. Nothing is stored ahead of time, so the view shows whatever matches when read.

Parameters3

name	string	required	Must be unique in the workspace, ignoring case.
description	string	optional	The view's purpose, shown below its name.
filter	object	optional	The view's filter. Empty means all mentions.

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "Must be unique in the workspace, ignoring case."
    },
    "description": {
      "type": "string",
      "maxLength": 500,
      "default": "",
      "description": "The view's purpose, shown below its name."
    },
    "filter": {
      "type": "object",
      "properties": {
        "q": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Searches post text and author names."
        },
        "keywordIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 50,
          "description": "Keeps matches of these keywords only."
        },
        "notKeywordIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 50,
          "description": "Keyword ids to exclude."
        },
        "keywordKinds": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "brand",
              "competitor",
              "topic"
            ]
          },
          "maxItems": 3,
          "description": "Keyword kinds to keep, out of brand, competitor and topic."
        },
        "groupIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 50,
          "description": "Limits to keywords from these groups (grp_...)."
        },
        "notGroupIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 50,
          "description": "Hides matches from keywords that belong to these groups."
        },
        "platforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "maxItems": 20,
          "description": "Keeps posts from these platforms only."
        },
        "notPlatforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "maxItems": 20,
          "description": "Platforms to exclude."
        },
        "status": {
          "type": "string",
          "enum": [
            "open",
            "ignored",
            "done"
          ],
          "description": "Keeps mentions with this status only (open, ignored or done)."
        },
        "relevant": {
          "type": "boolean",
          "description": "Filter on the classifier's verdict. true keeps relevant mentions, false the rest."
        },
        "minRelevance": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100,
          "description": "Minimum relevance score a mention needs."
        },
        "minConfidence": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "description": "Keeps mentions whose classifier confidence is this value or higher."
        },
        "sentiments": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "positive",
              "neutral",
              "negative"
            ],
            "description": "The sentiment the classifier assigned."
          },
          "maxItems": 3,
          "description": "Keeps mentions with these sentiments only."
        },
        "notSentiments": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "positive",
              "neutral",
              "negative"
            ],
            "description": "The sentiment the classifier assigned."
          },
          "maxItems": 3,
          "description": "Hides these sentiments. Unscored mentions stay."
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Keeps mentions tagged with one of these intents or topics."
        },
        "notIntents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Hides mentions with these tags."
        },
        "automated": {
          "type": "boolean",
          "description": "true keeps posts that look machine-made. false keeps the others."
        },
        "languages": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z]{2}$"
          },
          "maxItems": 20,
          "description": "Keeps posts in these languages only, as ISO 639-1 codes."
        },
        "notLanguages": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z]{2}$"
          },
          "maxItems": 20,
          "description": "Leaves out posts in these languages. Posts with an unknown language are kept."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Keeps authors your workspace gave one of these tags."
        },
        "notTags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Leaves out authors with one of these tags."
        },
        "linkHosts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "Keeps posts that link to one of these hosts or its subdomains."
        },
        "notLinkHosts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "Leaves out posts that link to these hosts."
        },
        "minFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps authors with this many followers or more. Unknown counts are left out."
        },
        "maxFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps authors with this many followers or fewer. Unknown counts are left out."
        },
        "isReply": {
          "type": "boolean",
          "description": "true keeps replies and comments. false keeps posts that are not replies."
        },
        "excludeAuthors": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 200,
          "description": "Leaves out these authors, given as display names, handles or profile links."
        },
        "ratings": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5
          },
          "maxItems": 5,
          "description": "Keeps reviews with one of these star ratings. Posts that are not reviews are left out."
        },
        "notRatings": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5
          },
          "maxItems": 5,
          "description": "Hides reviews with these star ratings. Other posts are not affected."
        },
        "minLikes": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
        },
        "minReposts": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
        },
        "minReplies": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
        },
        "minQuotes": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
        },
        "minViews": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
        },
        "minBookmarks": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
        },
        "anyOf": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "q": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200,
                "description": "Searches post text and author names."
              },
              "keywordIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Keeps matches of these keywords only."
              },
              "notKeywordIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Keyword ids to exclude."
              },
              "keywordKinds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "brand",
                    "competitor",
                    "topic"
                  ]
                },
                "maxItems": 3,
                "description": "Keyword kinds to keep, out of brand, competitor and topic."
              },
              "groupIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Limits to keywords from these groups (grp_...)."
              },
              "notGroupIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Hides matches from keywords that belong to these groups."
              },
              "platforms": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "bluesky",
                    "hackernews",
                    "github",
                    "stackoverflow",
                    "devto",
                    "reddit",
                    "x",
                    "youtube",
                    "news",
                    "linkedin",
                    "tiktok",
                    "instagram",
                    "appstore",
                    "googleplay",
                    "trustpilot",
                    "googlemaps"
                  ],
                  "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
                },
                "maxItems": 20,
                "description": "Keeps posts from these platforms only."
              },
              "notPlatforms": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "bluesky",
                    "hackernews",
                    "github",
                    "stackoverflow",
                    "devto",
                    "reddit",
                    "x",
                    "youtube",
                    "news",
                    "linkedin",
                    "tiktok",
                    "instagram",
                    "appstore",
                    "googleplay",
                    "trustpilot",
                    "googlemaps"
                  ],
                  "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
                },
                "maxItems": 20,
                "description": "Platforms to exclude."
              },
              "status": {
                "type": "string",
                "enum": [
                  "open",
                  "ignored",
                  "done"
                ],
                "description": "Keeps mentions with this status only (open, ignored or done)."
              },
              "relevant": {
                "type": "boolean",
                "description": "Filter on the classifier's verdict. true keeps relevant mentions, false the rest."
              },
              "minRelevance": {
                "type": "integer",
                "minimum": 0,
                "maximum": 100,
                "description": "Minimum relevance score a mention needs."
              },
              "minConfidence": {
                "type": "number",
                "minimum": 0,
                "maximum": 1,
                "description": "Keeps mentions whose classifier confidence is this value or higher."
              },
              "sentiments": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "description": "The sentiment the classifier assigned."
                },
                "maxItems": 3,
                "description": "Keeps mentions with these sentiments only."
              },
              "notSentiments": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "description": "The sentiment the classifier assigned."
                },
                "maxItems": 3,
                "description": "Hides these sentiments. Unscored mentions stay."
              },
              "intents": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Keeps mentions tagged with one of these intents or topics."
              },
              "notIntents": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Hides mentions with these tags."
              },
              "automated": {
                "type": "boolean",
                "description": "true keeps posts that look machine-made. false keeps the others."
              },
              "languages": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z]{2}$"
                },
                "maxItems": 20,
                "description": "Keeps posts in these languages only, as ISO 639-1 codes."
              },
              "notLanguages": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z]{2}$"
                },
                "maxItems": 20,
                "description": "Leaves out posts in these languages. Posts with an unknown language are kept."
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Keeps authors your workspace gave one of these tags."
              },
              "notTags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Leaves out authors with one of these tags."
              },
              "linkHosts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 20,
                "description": "Keeps posts that link to one of these hosts or its subdomains."
              },
              "notLinkHosts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 20,
                "description": "Leaves out posts that link to these hosts."
              },
              "minFollowers": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps authors with this many followers or more. Unknown counts are left out."
              },
              "maxFollowers": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps authors with this many followers or fewer. Unknown counts are left out."
              },
              "isReply": {
                "type": "boolean",
                "description": "true keeps replies and comments. false keeps posts that are not replies."
              },
              "excludeAuthors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 200,
                "description": "Leaves out these authors, given as display names, handles or profile links."
              },
              "ratings": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "maxItems": 5,
                "description": "Keeps reviews with one of these star ratings. Posts that are not reviews are left out."
              },
              "notRatings": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "maxItems": 5,
                "description": "Hides reviews with these star ratings. Other posts are not affected."
              },
              "minLikes": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
              },
              "minReposts": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
              },
              "minReplies": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
              },
              "minQuotes": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
              },
              "minViews": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
              },
              "minBookmarks": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
              }
            },
            "additionalProperties": false,
            "description": "A set of conditions that must all be true. It uses the same fields as a view filter, except anyOf."
          },
          "minItems": 1,
          "maxItems": 10,
          "description": "Up to 10 OR'd groups (at least 1). A mention must meet every condition of some group, plus all other conditions, so the filter reads (other conditions) AND (group 1 OR group 2 ...). Groups take view filter fields (platforms, sentiments, intents, keywordKinds, the not lists and so on) but no nested anyOf."
        }
      },
      "additionalProperties": false,
      "default": {},
      "description": "The view's filter. Empty means all mentions."
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

update_view

Changes a saved view's name, description or filter. `filter` sets the full new filter.

Parameters4

name	string	optional
description	string	optional
filter	object	optional	Sets the full new filter.
id	string	required	The view's id (vw_...)

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "description": {
      "type": "string",
      "maxLength": 500
    },
    "filter": {
      "type": "object",
      "properties": {
        "q": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Searches post text and author names."
        },
        "keywordIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 50,
          "description": "Keeps matches of these keywords only."
        },
        "notKeywordIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 50,
          "description": "Keyword ids to exclude."
        },
        "keywordKinds": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "brand",
              "competitor",
              "topic"
            ]
          },
          "maxItems": 3,
          "description": "Keyword kinds to keep, out of brand, competitor and topic."
        },
        "groupIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 50,
          "description": "Limits to keywords from these groups (grp_...)."
        },
        "notGroupIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 50,
          "description": "Hides matches from keywords that belong to these groups."
        },
        "platforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "maxItems": 20,
          "description": "Keeps posts from these platforms only."
        },
        "notPlatforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "maxItems": 20,
          "description": "Platforms to exclude."
        },
        "status": {
          "type": "string",
          "enum": [
            "open",
            "ignored",
            "done"
          ],
          "description": "Keeps mentions with this status only (open, ignored or done)."
        },
        "relevant": {
          "type": "boolean",
          "description": "Filter on the classifier's verdict. true keeps relevant mentions, false the rest."
        },
        "minRelevance": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100,
          "description": "Minimum relevance score a mention needs."
        },
        "minConfidence": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "description": "Keeps mentions whose classifier confidence is this value or higher."
        },
        "sentiments": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "positive",
              "neutral",
              "negative"
            ],
            "description": "The sentiment the classifier assigned."
          },
          "maxItems": 3,
          "description": "Keeps mentions with these sentiments only."
        },
        "notSentiments": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "positive",
              "neutral",
              "negative"
            ],
            "description": "The sentiment the classifier assigned."
          },
          "maxItems": 3,
          "description": "Hides these sentiments. Unscored mentions stay."
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Keeps mentions tagged with one of these intents or topics."
        },
        "notIntents": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Hides mentions with these tags."
        },
        "automated": {
          "type": "boolean",
          "description": "true keeps posts that look machine-made. false keeps the others."
        },
        "languages": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z]{2}$"
          },
          "maxItems": 20,
          "description": "Keeps posts in these languages only, as ISO 639-1 codes."
        },
        "notLanguages": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z]{2}$"
          },
          "maxItems": 20,
          "description": "Leaves out posts in these languages. Posts with an unknown language are kept."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Keeps authors your workspace gave one of these tags."
        },
        "notTags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Leaves out authors with one of these tags."
        },
        "linkHosts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "Keeps posts that link to one of these hosts or its subdomains."
        },
        "notLinkHosts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "Leaves out posts that link to these hosts."
        },
        "minFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps authors with this many followers or more. Unknown counts are left out."
        },
        "maxFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps authors with this many followers or fewer. Unknown counts are left out."
        },
        "isReply": {
          "type": "boolean",
          "description": "true keeps replies and comments. false keeps posts that are not replies."
        },
        "excludeAuthors": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 200,
          "description": "Leaves out these authors, given as display names, handles or profile links."
        },
        "ratings": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5
          },
          "maxItems": 5,
          "description": "Keeps reviews with one of these star ratings. Posts that are not reviews are left out."
        },
        "notRatings": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5
          },
          "maxItems": 5,
          "description": "Hides reviews with these star ratings. Other posts are not affected."
        },
        "minLikes": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
        },
        "minReposts": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
        },
        "minReplies": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
        },
        "minQuotes": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
        },
        "minViews": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
        },
        "minBookmarks": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
        },
        "anyOf": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "q": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200,
                "description": "Searches post text and author names."
              },
              "keywordIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Keeps matches of these keywords only."
              },
              "notKeywordIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Keyword ids to exclude."
              },
              "keywordKinds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "brand",
                    "competitor",
                    "topic"
                  ]
                },
                "maxItems": 3,
                "description": "Keyword kinds to keep, out of brand, competitor and topic."
              },
              "groupIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Limits to keywords from these groups (grp_...)."
              },
              "notGroupIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Hides matches from keywords that belong to these groups."
              },
              "platforms": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "bluesky",
                    "hackernews",
                    "github",
                    "stackoverflow",
                    "devto",
                    "reddit",
                    "x",
                    "youtube",
                    "news",
                    "linkedin",
                    "tiktok",
                    "instagram",
                    "appstore",
                    "googleplay",
                    "trustpilot",
                    "googlemaps"
                  ],
                  "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
                },
                "maxItems": 20,
                "description": "Keeps posts from these platforms only."
              },
              "notPlatforms": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "bluesky",
                    "hackernews",
                    "github",
                    "stackoverflow",
                    "devto",
                    "reddit",
                    "x",
                    "youtube",
                    "news",
                    "linkedin",
                    "tiktok",
                    "instagram",
                    "appstore",
                    "googleplay",
                    "trustpilot",
                    "googlemaps"
                  ],
                  "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
                },
                "maxItems": 20,
                "description": "Platforms to exclude."
              },
              "status": {
                "type": "string",
                "enum": [
                  "open",
                  "ignored",
                  "done"
                ],
                "description": "Keeps mentions with this status only (open, ignored or done)."
              },
              "relevant": {
                "type": "boolean",
                "description": "Filter on the classifier's verdict. true keeps relevant mentions, false the rest."
              },
              "minRelevance": {
                "type": "integer",
                "minimum": 0,
                "maximum": 100,
                "description": "Minimum relevance score a mention needs."
              },
              "minConfidence": {
                "type": "number",
                "minimum": 0,
                "maximum": 1,
                "description": "Keeps mentions whose classifier confidence is this value or higher."
              },
              "sentiments": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "description": "The sentiment the classifier assigned."
                },
                "maxItems": 3,
                "description": "Keeps mentions with these sentiments only."
              },
              "notSentiments": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "description": "The sentiment the classifier assigned."
                },
                "maxItems": 3,
                "description": "Hides these sentiments. Unscored mentions stay."
              },
              "intents": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Keeps mentions tagged with one of these intents or topics."
              },
              "notIntents": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Hides mentions with these tags."
              },
              "automated": {
                "type": "boolean",
                "description": "true keeps posts that look machine-made. false keeps the others."
              },
              "languages": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z]{2}$"
                },
                "maxItems": 20,
                "description": "Keeps posts in these languages only, as ISO 639-1 codes."
              },
              "notLanguages": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z]{2}$"
                },
                "maxItems": 20,
                "description": "Leaves out posts in these languages. Posts with an unknown language are kept."
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Keeps authors your workspace gave one of these tags."
              },
              "notTags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Leaves out authors with one of these tags."
              },
              "linkHosts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 20,
                "description": "Keeps posts that link to one of these hosts or its subdomains."
              },
              "notLinkHosts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 20,
                "description": "Leaves out posts that link to these hosts."
              },
              "minFollowers": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps authors with this many followers or more. Unknown counts are left out."
              },
              "maxFollowers": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps authors with this many followers or fewer. Unknown counts are left out."
              },
              "isReply": {
                "type": "boolean",
                "description": "true keeps replies and comments. false keeps posts that are not replies."
              },
              "excludeAuthors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 200,
                "description": "Leaves out these authors, given as display names, handles or profile links."
              },
              "ratings": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "maxItems": 5,
                "description": "Keeps reviews with one of these star ratings. Posts that are not reviews are left out."
              },
              "notRatings": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "maxItems": 5,
                "description": "Hides reviews with these star ratings. Other posts are not affected."
              },
              "minLikes": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
              },
              "minReposts": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
              },
              "minReplies": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
              },
              "minQuotes": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
              },
              "minViews": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
              },
              "minBookmarks": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
              }
            },
            "additionalProperties": false,
            "description": "A set of conditions that must all be true. It uses the same fields as a view filter, except anyOf."
          },
          "minItems": 1,
          "maxItems": 10,
          "description": "Up to 10 OR'd groups (at least 1). A mention must meet every condition of some group, plus all other conditions, so the filter reads (other conditions) AND (group 1 OR group 2 ...). Groups take view filter fields (platforms, sentiments, intents, keywordKinds, the not lists and so on) but no nested anyOf."
        }
      },
      "additionalProperties": false,
      "description": "Sets the full new filter."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The view's id (vw_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

delete_view

Deletes a saved view and leaves its mentions untouched.

Parameters1

string

required

The view's id (vw_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The view's id (vw_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

list_groups

Lists the workspace's keyword groups, the default first. Groups organize keywords, for example by client, campaign or product. Every keyword is in one group, a group can hold a term once, and get_usage_breakdown with by=group shows each group's cost. externalId finds the group with your own id.

Parameters1

externalId

string

optional

Filters to the one group whose externalId matches exactly.

Raw schema

{
  "type": "object",
  "properties": {
    "externalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Filters to the one group whose externalId matches exactly."
    }
  },
  "additionalProperties": false
}

get_group

Returns a keyword group by id, with its number of keywords.

Parameters1

string

required

The group's id (grp_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The group's id (grp_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

create_group

Creates a keyword group with a name that is unique in the workspace. You can add externalId, your own unique id such as a client id. You can also add context, a company description saying who the business is, what it sells and to whom. The classifier reads it instead of the whole workspace profile, guidelines and competitors included, for this group's keywords, so put any group rule in that text. An agency can make one group per client with the client's description, so each client's mentions are scored for that client. Then pass the group's id as groupId to add_keyword.

Parameters3

name	string	required	The group's name, such as a client, campaign or product. Must be unique in the workspace.
externalId	any	optional	An id from your own system, such as a client id. Must be unique in the workspace. Find the group with GET /v1/groups?externalId=.
context	any	optional	Up to 4000 characters the classifier treats as "the company" for this group's keywords. It fully replaces the workspace profile, including its relevance guidelines and competitors. Describe the business, what it sells and to whom, what it is not, and any rule for this group, such as "ignore job posts". With one group per client, use the client's description. Null means the workspace profile is used.

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "The group's name, such as a client, campaign or product. Must be unique in the workspace."
    },
    "externalId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "description": "An id from your own system, such as a client id. Must be unique in the workspace. Find the group with GET /v1/groups?externalId=."
        },
        {
          "type": "null"
        }
      ],
      "description": "An id from your own system, such as a client id. Must be unique in the workspace. Find the group with GET /v1/groups?externalId=."
    },
    "context": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 4000,
          "description": "Up to 4000 characters the classifier treats as \"the company\" for this group's keywords. It fully replaces the workspace profile, including its relevance guidelines and competitors. Describe the business, what it sells and to whom, what it is not, and any rule for this group, such as \"ignore job posts\". With one group per client, use the client's description. Null means the workspace profile is used."
        },
        {
          "type": "null"
        }
      ],
      "description": "Up to 4000 characters the classifier treats as \"the company\" for this group's keywords. It fully replaces the workspace profile, including its relevance guidelines and competitors. Describe the business, what it sells and to whom, what it is not, and any rule for this group, such as \"ignore job posts\". With one group per client, use the client's description. Null means the workspace profile is used."
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

update_group

Changes a keyword group's name, its externalId or its company description in context. Null clears externalId. Null clears context too, so the workspace profile applies again, and new mentions use the change right away. The default group can be renamed but takes no description, because it is the workspace itself and uses the company profile (update_company).

Parameters4

name	string	optional	The group's name, such as a client, campaign or product. Must be unique in the workspace.
externalId	any	optional	Sets a new external id. Null removes it.
context	any	optional	Sets a new company description for the group. Null removes it, and the workspace profile applies again. New mentions use it right away, and older ones are not scored again. The default group cannot have one (400 default_group_context), because it is the workspace itself and uses the profile.
id	string	required	The group's id (grp_...)

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "The group's name, such as a client, campaign or product. Must be unique in the workspace."
    },
    "externalId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "description": "An id from your own system, such as a client id. Must be unique in the workspace. Find the group with GET /v1/groups?externalId=."
        },
        {
          "type": "null"
        }
      ],
      "description": "Sets a new external id. Null removes it."
    },
    "context": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 4000,
          "description": "Up to 4000 characters the classifier treats as \"the company\" for this group's keywords. It fully replaces the workspace profile, including its relevance guidelines and competitors. Describe the business, what it sells and to whom, what it is not, and any rule for this group, such as \"ignore job posts\". With one group per client, use the client's description. Null means the workspace profile is used."
        },
        {
          "type": "null"
        }
      ],
      "description": "Sets a new company description for the group. Null removes it, and the workspace profile applies again. New mentions use it right away, and older ones are not scored again. The default group cannot have one (400 default_group_context), because it is the workspace itself and uses the profile."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The group's id (grp_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "description": "Fields you leave out stay as they are."
}

delete_group

Deletes a keyword group and all of its keywords, each as delete_keyword would, mentions included. The default group cannot be deleted. The answer says how many keywords were deleted.

Parameters1

string

required

The group's id (grp_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The group's id (grp_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

search_mentions

Searches the workspace's mentions. You can filter by keyword, platform, status (open, ignored, done), relevant, minimum relevance, minimum confidence (0 to 1), sentiment, intent, text (q, in the post or the author's name) and time range (ISO 8601). You can also filter by one person (personId from list_people), assignee (assigneeId), author followers (minFollowers, maxFollowers), engagement counts from the platform (minLikes, minReposts, minReplies, minQuotes, minViews, minBookmarks, where posts without that count are left out), review stars (ratings, or notRatings to exclude some), author tags (tags, any of them), linked hosts (linkHosts, a host or its subdomains), replies or not (isReply), and machine-made posts (automated true or false). alertId applies an alert's whole filter, giving the mentions it would send. viewId applies a saved view from list_views on top of the rest. keywordKinds filters by the kind of keyword that matched (brand, competitor, topic), and groupIds or notGroupIds by the keyword's group (ids from list_groups). All filters are joined by AND. For OR, anyOf takes up to 10 groups of the same conditions, each an object whose conditions are joined by AND, and keeps a mention when one group matches as well as the rest. For example anyOf=[{platforms:["github"],intents:["bug_report"]},{sentiments:["negative"]}]. Snoozed mentions are hidden unless snoozed=true. sort is "newest" (the default) or "priority", an attention score built from relevance, author reach, intent and age that covers only the past 30 days of matches and comes on each mention as `priority`. Returns 10 mentions by default, up to 100 with limit. Each mention contains post, author, classification and triage.

Parameters50

keywordId	string	optional	Only this keyword's matches.
platform	string	optional	Only this platform's posts.
status	string	optional	Keeps mentions with this status only. Leave it out for all statuses.
relevant	boolean	optional	true keeps mentions the classifier scored relevant. false keeps the others, including unscored ones.
sentiment	string	optional	Keeps mentions with this sentiment only.
intent	string	optional	Returns only mentions with this tag. One of bug_report, buy_intent, churn_intent, comparison, complaint, event, feedback, hiring, industry_insight, launch, praise, pricing, promotional, question and testimonial.
automated	boolean	optional	true keeps mentions that look machine-made, such as bot accounts, scheduled or template posts and AI-written text. false keeps the others, including mentions scored before this flag existed. Leave it out for all.
personId	string	optional	Keeps mentions by this person (an id from /v1/people), including merged accounts. Turns on includeMuted.
includeMuted	boolean	optional	true also returns mentions by muted people, which are hidden by default.
assigneeId	string	optional	Member user id. Returns only mentions assigned to them.
snoozed	boolean	optional	true shows only snoozed mentions, which are otherwise hidden until they wake.
excludeAuthors	array	optional	Leaves out these authors, given as display names, handles or profile links. Repeat the parameter or send one value with commas.
minRelevance	integer	optional	Keeps mentions with this relevance score or higher. Unscored mentions are left out.
minConfidence	number	optional	Minimum classifier confidence, 0 to 1. Mentions with no confidence are dropped.
minFollowers	integer	optional	Sends only posts by authors with this many followers or more. Unknown counts are left out.
maxFollowers	integer	optional	Keeps posts by authors with this many followers or fewer. Unknown counts are left out.
isReply	boolean	optional	true keeps replies and comments, meaning posts that answer another post. false keeps posts that are not replies. Leave it out for both.
alertId	string	optional	Adds an alert rule's filter (an id from GET /v1/alerts) to the other filters. You get the mentions the rule would send, useful for a preview or an export in feed form. An unknown id returns 404.
viewId	string	optional	Adds a saved view's filter (an id from GET /v1/views) to the other filters, with every condition joined by AND. You get exactly what the view shows. An unknown id returns 404.
keywordKinds	array	optional	Keeps matches of keywords of these kinds only (brand, competitor, topic). Repeat the parameter or separate values with commas.
tags	array	optional	Keeps authors your workspace gave one of these tags, matched exactly and by case. Repeat the parameter or separate values with commas.
linkHosts	array	optional	Keeps posts that link to one of these hosts or its subdomains, so slack.com also matches api.slack.com. Repeat the parameter or separate values with commas.
platforms	array	optional	Keeps posts from these platforms only.
notPlatforms	array	optional	Platforms to exclude.
keywordIds	array	optional	Keeps matches of these keywords only.
groupIds	array	optional	Keeps matches of keywords in these groups only (grp_...). Repeat the parameter or separate values with commas.
notGroupIds	array	optional	Hides matches from keywords that belong to these groups.
notKeywordIds	array	optional	Keyword ids to exclude.
sentiments	array	optional	Keeps mentions with these sentiments only.
notSentiments	array	optional	Leaves out these sentiments. Mentions not scored yet are kept.
intents	array	optional	Keeps mentions tagged with one of these intents or topics.
notIntents	array	optional	Intent or topic tags to exclude.
notLinkHosts	array	optional	Leaves out posts that link to these hosts or their subdomains.
notTags	array	optional	Leaves out authors your workspace gave one of these tags.
languages	array	optional	Sends only posts in these languages, as ISO 639-1 codes such as en, es or de. Posts with an unknown language are left out.
notLanguages	array	optional	Leaves out posts in these languages. Posts with an unknown language are kept.
ratings	array	optional	Keeps reviews with one of these star ratings, from 1 to 5. Use ratings=1,2 for the unhappy ones. Posts that are not reviews are left out.
notRatings	array	optional	Star ratings (1 to 5) to hide, such as notRatings=5. Other posts are unaffected.
minLikes	integer	optional	Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out.
minReposts	integer	optional	Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out.
minReplies	integer	optional	Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out.
minQuotes	integer	optional	Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out.
minViews	integer	optional	Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out.
minBookmarks	integer	optional	Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out.
anyOf	array	optional	Up to 10 OR'd groups (at least 1). A mention must meet every condition of some group, plus all other conditions, so the filter reads (other conditions) AND (group 1 OR group 2 ...). Groups take view filter fields (platforms, sentiments, intents, keywordKinds, the not lists and so on) but no nested anyOf.
q	string	optional	Searches post text and author names.
since	integer	optional	Keeps posts published at this time or later, as ISO 8601 or epoch ms.
until	integer	optional	Keeps posts published at this time or earlier, as ISO 8601 or epoch ms.
sort	string	optional	newest orders by match time, latest first. priority orders by attention score, highest first, and only covers the past 30 days of matches. Older ones are still available with newest. A cursor only works with the sort it came from.
limit	integer	optional	How many mentions to return, from 1 to 100. The default is 10, so narrow the filters before you ask for more.

Raw schema

{
  "type": "object",
  "properties": {
    "keywordId": {
      "type": "string",
      "description": "Only this keyword's matches."
    },
    "platform": {
      "type": "string",
      "enum": [
        "bluesky",
        "hackernews",
        "github",
        "stackoverflow",
        "devto",
        "reddit",
        "x",
        "youtube",
        "news",
        "linkedin",
        "tiktok",
        "instagram",
        "appstore",
        "googleplay",
        "trustpilot",
        "googlemaps"
      ],
      "description": "Only this platform's posts."
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "ignored",
        "done"
      ],
      "description": "Keeps mentions with this status only. Leave it out for all statuses."
    },
    "relevant": {
      "type": "boolean",
      "description": "true keeps mentions the classifier scored relevant. false keeps the others, including unscored ones."
    },
    "sentiment": {
      "type": "string",
      "enum": [
        "positive",
        "neutral",
        "negative"
      ],
      "description": "Keeps mentions with this sentiment only."
    },
    "intent": {
      "type": "string",
      "description": "Returns only mentions with this tag. One of bug_report, buy_intent, churn_intent, comparison, complaint, event, feedback, hiring, industry_insight, launch, praise, pricing, promotional, question and testimonial."
    },
    "automated": {
      "type": "boolean",
      "description": "true keeps mentions that look machine-made, such as bot accounts, scheduled or template posts and AI-written text. false keeps the others, including mentions scored before this flag existed. Leave it out for all."
    },
    "personId": {
      "type": "string",
      "minLength": 1,
      "description": "Keeps mentions by this person (an id from /v1/people), including merged accounts. Turns on includeMuted."
    },
    "includeMuted": {
      "type": "boolean",
      "description": "true also returns mentions by muted people, which are hidden by default."
    },
    "assigneeId": {
      "type": "string",
      "minLength": 1,
      "description": "Member user id. Returns only mentions assigned to them."
    },
    "snoozed": {
      "type": "boolean",
      "description": "true shows only snoozed mentions, which are otherwise hidden until they wake."
    },
    "excludeAuthors": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 200,
      "description": "Leaves out these authors, given as display names, handles or profile links. Repeat the parameter or send one value with commas."
    },
    "minRelevance": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100,
      "description": "Keeps mentions with this relevance score or higher. Unscored mentions are left out."
    },
    "minConfidence": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "description": "Minimum classifier confidence, 0 to 1. Mentions with no confidence are dropped."
    },
    "minFollowers": {
      "type": "integer",
      "minimum": 0,
      "description": "Sends only posts by authors with this many followers or more. Unknown counts are left out."
    },
    "maxFollowers": {
      "type": "integer",
      "minimum": 0,
      "description": "Keeps posts by authors with this many followers or fewer. Unknown counts are left out."
    },
    "isReply": {
      "type": "boolean",
      "description": "true keeps replies and comments, meaning posts that answer another post. false keeps posts that are not replies. Leave it out for both."
    },
    "alertId": {
      "type": "string",
      "minLength": 1,
      "description": "Adds an alert rule's filter (an id from GET /v1/alerts) to the other filters. You get the mentions the rule would send, useful for a preview or an export in feed form. An unknown id returns 404."
    },
    "viewId": {
      "type": "string",
      "minLength": 1,
      "description": "Adds a saved view's filter (an id from GET /v1/views) to the other filters, with every condition joined by AND. You get exactly what the view shows. An unknown id returns 404."
    },
    "keywordKinds": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "brand",
          "competitor",
          "topic"
        ]
      },
      "maxItems": 3,
      "description": "Keeps matches of keywords of these kinds only (brand, competitor, topic). Repeat the parameter or separate values with commas."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Keeps authors your workspace gave one of these tags, matched exactly and by case. Repeat the parameter or separate values with commas."
    },
    "linkHosts": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Keeps posts that link to one of these hosts or its subdomains, so slack.com also matches api.slack.com. Repeat the parameter or separate values with commas."
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ],
        "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
      },
      "maxItems": 20,
      "description": "Keeps posts from these platforms only."
    },
    "notPlatforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ],
        "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
      },
      "maxItems": 20,
      "description": "Platforms to exclude."
    },
    "keywordIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keeps matches of these keywords only."
    },
    "groupIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keeps matches of keywords in these groups only (grp_...). Repeat the parameter or separate values with commas."
    },
    "notGroupIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Hides matches from keywords that belong to these groups."
    },
    "notKeywordIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keyword ids to exclude."
    },
    "sentiments": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "positive",
          "neutral",
          "negative"
        ],
        "description": "The sentiment the classifier assigned."
      },
      "maxItems": 3,
      "description": "Keeps mentions with these sentiments only."
    },
    "notSentiments": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "positive",
          "neutral",
          "negative"
        ],
        "description": "The sentiment the classifier assigned."
      },
      "maxItems": 3,
      "description": "Leaves out these sentiments. Mentions not scored yet are kept."
    },
    "intents": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Keeps mentions tagged with one of these intents or topics."
    },
    "notIntents": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Intent or topic tags to exclude."
    },
    "notLinkHosts": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Leaves out posts that link to these hosts or their subdomains."
    },
    "notTags": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Leaves out authors your workspace gave one of these tags."
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-z]{2}$"
      },
      "maxItems": 20,
      "description": "Sends only posts in these languages, as ISO 639-1 codes such as en, es or de. Posts with an unknown language are left out."
    },
    "notLanguages": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-z]{2}$"
      },
      "maxItems": 20,
      "description": "Leaves out posts in these languages. Posts with an unknown language are kept."
    },
    "ratings": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": 1,
        "maximum": 5
      },
      "maxItems": 5,
      "description": "Keeps reviews with one of these star ratings, from 1 to 5. Use ratings=1,2 for the unhappy ones. Posts that are not reviews are left out."
    },
    "notRatings": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": 1,
        "maximum": 5
      },
      "maxItems": 5,
      "description": "Star ratings (1 to 5) to hide, such as notRatings=5. Other posts are unaffected."
    },
    "minLikes": {
      "type": "integer",
      "minimum": 0,
      "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
    },
    "minReposts": {
      "type": "integer",
      "minimum": 0,
      "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
    },
    "minReplies": {
      "type": "integer",
      "minimum": 0,
      "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
    },
    "minQuotes": {
      "type": "integer",
      "minimum": 0,
      "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
    },
    "minViews": {
      "type": "integer",
      "minimum": 0,
      "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
    },
    "minBookmarks": {
      "type": "integer",
      "minimum": 0,
      "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
    },
    "anyOf": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "q": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "description": "Searches post text and author names."
          },
          "keywordIds": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "maxItems": 50,
            "description": "Keeps matches of these keywords only."
          },
          "notKeywordIds": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "maxItems": 50,
            "description": "Keyword ids to exclude."
          },
          "keywordKinds": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "brand",
                "competitor",
                "topic"
              ]
            },
            "maxItems": 3,
            "description": "Keyword kinds to keep, out of brand, competitor and topic."
          },
          "groupIds": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "maxItems": 50,
            "description": "Limits to keywords from these groups (grp_...)."
          },
          "notGroupIds": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "maxItems": 50,
            "description": "Hides matches from keywords that belong to these groups."
          },
          "platforms": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "bluesky",
                "hackernews",
                "github",
                "stackoverflow",
                "devto",
                "reddit",
                "x",
                "youtube",
                "news",
                "linkedin",
                "tiktok",
                "instagram",
                "appstore",
                "googleplay",
                "trustpilot",
                "googlemaps"
              ],
              "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
            },
            "maxItems": 20,
            "description": "Keeps posts from these platforms only."
          },
          "notPlatforms": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "bluesky",
                "hackernews",
                "github",
                "stackoverflow",
                "devto",
                "reddit",
                "x",
                "youtube",
                "news",
                "linkedin",
                "tiktok",
                "instagram",
                "appstore",
                "googleplay",
                "trustpilot",
                "googlemaps"
              ],
              "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
            },
            "maxItems": 20,
            "description": "Platforms to exclude."
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "ignored",
              "done"
            ],
            "description": "Keeps mentions with this status only (open, ignored or done)."
          },
          "relevant": {
            "type": "boolean",
            "description": "Filter on the classifier's verdict. true keeps relevant mentions, false the rest."
          },
          "minRelevance": {
            "type": "integer",
            "minimum": 0,
            "maximum": 100,
            "description": "Minimum relevance score a mention needs."
          },
          "minConfidence": {
            "type": "number",
            "minimum": 0,
            "maximum": 1,
            "description": "Keeps mentions whose classifier confidence is this value or higher."
          },
          "sentiments": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "positive",
                "neutral",
                "negative"
              ],
              "description": "The sentiment the classifier assigned."
            },
            "maxItems": 3,
            "description": "Keeps mentions with these sentiments only."
          },
          "notSentiments": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "positive",
                "neutral",
                "negative"
              ],
              "description": "The sentiment the classifier assigned."
            },
            "maxItems": 3,
            "description": "Hides these sentiments. Unscored mentions stay."
          },
          "intents": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "maxItems": 20,
            "description": "Keeps mentions tagged with one of these intents or topics."
          },
          "notIntents": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "maxItems": 20,
            "description": "Hides mentions with these tags."
          },
          "automated": {
            "type": "boolean",
            "description": "true keeps posts that look machine-made. false keeps the others."
          },
          "languages": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[a-z]{2}$"
            },
            "maxItems": 20,
            "description": "Keeps posts in these languages only, as ISO 639-1 codes."
          },
          "notLanguages": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[a-z]{2}$"
            },
            "maxItems": 20,
            "description": "Leaves out posts in these languages. Posts with an unknown language are kept."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "maxItems": 20,
            "description": "Keeps authors your workspace gave one of these tags."
          },
          "notTags": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "maxItems": 20,
            "description": "Leaves out authors with one of these tags."
          },
          "linkHosts": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "maxItems": 20,
            "description": "Keeps posts that link to one of these hosts or its subdomains."
          },
          "notLinkHosts": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "maxItems": 20,
            "description": "Leaves out posts that link to these hosts."
          },
          "minFollowers": {
            "type": "integer",
            "minimum": 0,
            "description": "Keeps authors with this many followers or more. Unknown counts are left out."
          },
          "maxFollowers": {
            "type": "integer",
            "minimum": 0,
            "description": "Keeps authors with this many followers or fewer. Unknown counts are left out."
          },
          "isReply": {
            "type": "boolean",
            "description": "true keeps replies and comments. false keeps posts that are not replies."
          },
          "excludeAuthors": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "maxItems": 200,
            "description": "Leaves out these authors, given as display names, handles or profile links."
          },
          "ratings": {
            "type": "array",
            "items": {
              "type": "integer",
              "minimum": 1,
              "maximum": 5
            },
            "maxItems": 5,
            "description": "Keeps reviews with one of these star ratings. Posts that are not reviews are left out."
          },
          "notRatings": {
            "type": "array",
            "items": {
              "type": "integer",
              "minimum": 1,
              "maximum": 5
            },
            "maxItems": 5,
            "description": "Hides reviews with these star ratings. Other posts are not affected."
          },
          "minLikes": {
            "type": "integer",
            "minimum": 0,
            "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
          },
          "minReposts": {
            "type": "integer",
            "minimum": 0,
            "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
          },
          "minReplies": {
            "type": "integer",
            "minimum": 0,
            "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
          },
          "minQuotes": {
            "type": "integer",
            "minimum": 0,
            "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
          },
          "minViews": {
            "type": "integer",
            "minimum": 0,
            "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
          },
          "minBookmarks": {
            "type": "integer",
            "minimum": 0,
            "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
          }
        },
        "additionalProperties": false,
        "description": "A set of conditions that must all be true. It uses the same fields as a view filter, except anyOf."
      },
      "minItems": 1,
      "maxItems": 10,
      "description": "Up to 10 OR'd groups (at least 1). A mention must meet every condition of some group, plus all other conditions, so the filter reads (other conditions) AND (group 1 OR group 2 ...). Groups take view filter fields (platforms, sentiments, intents, keywordKinds, the not lists and so on) but no nested anyOf."
    },
    "q": {
      "type": "string",
      "description": "Searches post text and author names."
    },
    "since": {
      "type": "integer",
      "description": "Keeps posts published at this time or later, as ISO 8601 or epoch ms."
    },
    "until": {
      "type": "integer",
      "description": "Keeps posts published at this time or earlier, as ISO 8601 or epoch ms."
    },
    "sort": {
      "type": "string",
      "enum": [
        "newest",
        "priority"
      ],
      "description": "newest orders by match time, latest first. priority orders by attention score, highest first, and only covers the past 30 days of matches. Older ones are still available with newest. A cursor only works with the sort it came from.",
      "default": "newest"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 10,
      "description": "How many mentions to return, from 1 to 100. The default is 10, so narrow the filters before you ask for more."
    }
  },
  "additionalProperties": false
}

get_mention

Fetches one mention, classification included (relevance, sentiment, intents, confidence, uncertain, note).

Parameters1

string

required

The mention's id (mm_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The mention's id (mm_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

update_mention

The only way to change a mention. Set status to "ignored" when it is not interesting, "done" when handled, or "open" to reopen it. Assign it with assigneeId, or null to remove the assignment. Hide it from the feed until an ISO 8601 time with snoozedUntil, or null to bring it back. Add a team note with note, or null to remove it. Correct the classifier with `relevant`, where true or false sets relevance to 100 or 0 and moves the mention into or out of the relevant feed, and null removes your judgment. `sentiment` sets the label, and null brings back the classifier's. Use these corrections when the user says a mention is noise or was missed. Fields you leave out stay as they are. Delivery and billing never change.

Parameters7

status	string	optional	ignored or done marks it handled, and open reopens it.
assigneeId	any	optional	The user id of a workspace member, or null to remove the assignment.
snoozedUntil	any	optional	Hides the mention from the feed until this time, given as ISO 8601 or epoch ms. Send null to bring it back now.
note	any	optional	A note for your team. Null or an empty string removes it.
relevant	boolean \| null	optional	Set it to override the classifier, or null to restore the classifier's score. true means relevance 100, and a filtered mention joins the relevant feed. false means 0, and it leaves. Billing is unaffected. While the mention is still being classified this returns 409 classification_pending.
sentiment	any	optional	The sentiment you choose. Null removes it and brings back the classifier's.
id	string	required	Mention id (mm_...)

Raw schema

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "open",
        "ignored",
        "done"
      ],
      "description": "ignored or done marks it handled, and open reopens it."
    },
    "assigneeId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "description": "The user id of a workspace member, or null to remove the assignment."
    },
    "snoozedUntil": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Hides the mention from the feed until this time, given as ISO 8601 or epoch ms. Send null to bring it back now."
    },
    "note": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "null"
        }
      ],
      "description": "A note for your team. Null or an empty string removes it."
    },
    "relevant": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Set it to override the classifier, or null to restore the classifier's score. true means relevance 100, and a filtered mention joins the relevant feed. false means 0, and it leaves. Billing is unaffected. While the mention is still being classified this returns 409 classification_pending."
    },
    "sentiment": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "positive",
            "neutral",
            "negative"
          ],
          "description": "The sentiment the classifier assigned."
        },
        {
          "type": "null"
        }
      ],
      "description": "The sentiment you choose. Null removes it and brings back the classifier's."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "Mention id (mm_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "description": "All fields are optional. Fields you leave out stay as they are."
}

add_keyword

Creates a keyword to track. kind is "brand" (default), "competitor" or "topic". platforms limits where it runs, all by default. New posts with the term are matched, classified and delivered. To narrow a common word, set `matching` (requiredTerms with requiredMode any or all, excludedTerms with a `*` wildcard at either end, excludedAuthors, caseSensitive). Rejected posts are never stored or billed. `context` is one sentence for this keyword's classifier, such as "Driftwood is our deploy tool, not beach wood." `cap` ({ mentions: N }) sets a monthly limit on matches. A capped keyword stops matching until the 1st (UTC) or a higher cap, and is still charged daily. `groupId` picks a group from list_groups, otherwise the default group. A term can exist once per group. `reviewSources` adds review pages, each as a url (App Store or Google Play app, Trustpilot page, Google Maps place or maps.app.goo.gl link) or a platform (appstore, googleplay, trustpilot, googlemaps) and id. App stores also take countries (two-letter, default us), and Google Play a language (default en). Every review becomes a mention, pages are read daily, and the last 30 days (up to 100 reviews) arrive free at once. `platforms: []` makes a reviews-only keyword.

Parameters8

term	string	required	The word or phrase to monitor. It matches as a whole phrase, ignoring case.
kind	string	optional	brand is for your own names, competitor for a rival's, and topic for your market. Share of voice and segments use it.
platforms	any	optional	The platforms to search for the term. Leave it out or send null for all platforms. An empty list searches nowhere, for a keyword that only collects reviews and so needs reviewSources.
context	any	optional	Up to 300 characters the classifier reads for this keyword only, in addition to the company profile or the group's description. Say what the term means for you and what to ignore, for example "Driftwood is our deploy tool, not beach wood." Null clears it.
matching	object	optional	Fields you leave out stay as they are. An empty list clears a field.
cap	any	optional	Monthly limit on matched mentions. Omit or null means none.
groupId	string	optional	The group to put it in (grp_...). Without it, the workspace's default group is used. Each group can hold a term only once.
reviewSources	array	optional	Review pages for this keyword, at most 10 (App Store and Google Play apps, Trustpilot pages, Google Maps places). Every new review on them is a mention, whatever it says. Pages are read daily, per country on the app stores. A newly added page imports its last 30 days, up to 100 newest reviews per country, free and without instant alerts. Later reviews are billed like other mentions.

Raw schema

{
  "type": "object",
  "properties": {
    "term": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80,
      "description": "The word or phrase to monitor. It matches as a whole phrase, ignoring case."
    },
    "kind": {
      "type": "string",
      "enum": [
        "brand",
        "competitor",
        "topic"
      ],
      "default": "brand",
      "description": "brand is for your own names, competitor for a rival's, and topic for your market. Share of voice and segments use it."
    },
    "platforms": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram"
            ]
          }
        },
        {
          "type": "null"
        }
      ],
      "description": "The platforms to search for the term. Leave it out or send null for all platforms. An empty list searches nowhere, for a keyword that only collects reviews and so needs reviewSources."
    },
    "context": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 300,
          "description": "Up to 300 characters the classifier reads for this keyword only, in addition to the company profile or the group's description. Say what the term means for you and what to ignore, for example \"Driftwood is our deploy tool, not beach wood.\" Null clears it."
        },
        {
          "type": "null"
        }
      ],
      "description": "Up to 300 characters the classifier reads for this keyword only, in addition to the company profile or the group's description. Say what the term means for you and what to ignore, for example \"Driftwood is our deploy tool, not beach wood.\" Null clears it."
    },
    "matching": {
      "type": "object",
      "properties": {
        "requiredTerms": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "maxItems": 50,
          "description": "Terms the post must contain as well. requiredMode says whether one or all of them must appear. An empty list sets no requirement."
        },
        "requiredMode": {
          "type": "string",
          "enum": [
            "any",
            "all"
          ],
          "description": "any needs one of the required terms in the post. all needs every one."
        },
        "excludedTerms": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "maxItems": 50,
          "description": "Posts that contain one of these terms are dropped. Put `*` at the start or end of a term as a wildcard, so deploy* matches deployment and *bot matches nightlybot."
        },
        "excludedAuthors": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
          },
          "maxItems": 100,
          "description": "Authors whose posts this keyword ignores. Each entry is a profile or post link, @handle, u/name, Bluesky DID or display name. Entries are normalized the same way as an alert's muted authors."
        },
        "caseSensitive": {
          "type": "boolean",
          "description": "When true, the term only matches in the exact case you typed, so RAG never matches rag. Defaults to false."
        }
      },
      "additionalProperties": false,
      "description": "Fields you leave out stay as they are. An empty list clears a field."
    },
    "cap": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "mentions": {
              "type": "integer",
              "minimum": 1,
              "maximum": 1000000,
              "description": "How many matched mentions the keyword may collect per calendar month (UTC). Every match counts, relevant or not, including a new keyword's look-back, since every match is billed."
            }
          },
          "required": [
            "mentions"
          ],
          "additionalProperties": false,
          "description": "The most mentions this keyword can match per month. At the cap it stops matching until the 1st of next month (UTC), or until the cap is raised or removed. It is not muted, so its daily charge continues. Mute it to stop that as well."
        },
        {
          "type": "null"
        }
      ],
      "description": "Monthly limit on matched mentions. Omit or null means none."
    },
    "groupId": {
      "type": "string",
      "minLength": 1,
      "description": "The group to put it in (grp_...). Without it, the workspace's default group is used. Each group can hold a term only once."
    },
    "reviewSources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500,
            "description": "Review page link, or send platform and id instead. Accepts App Store and Google Play app links (https://apps.apple.com/us/app/slack/id618783545, https://play.google.com/store/apps/details?id=com.Slack), Trustpilot pages (https://www.trustpilot.com/review/slack.com) and Google Maps places (full or maps.app.goo.gl link)."
          },
          "platform": {
            "type": "string",
            "enum": [
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "Where the reviews come from. appstore is the Apple App Store, googleplay is Google Play, trustpilot is a company's Trustpilot page and googlemaps is the Google reviews of a place."
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "description": "The platform's own id. On the App Store it is the number after \"id\" in the link, on Google Play the package name, on Trustpilot the company's domain (slack.com) and on Google Maps a Place ID (ChIJ...)."
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[A-Za-z]{2}$"
            },
            "minItems": 1,
            "maxItems": 20,
            "description": "For App Store and Google Play. Up to 20 storefronts to read, as two-letter codes. Without it, the storefront in the link is used, or us. Each storefront adds one poll a day, and a review found in two storefronts is still one mention. Trustpilot and Google Maps have a single page and take no countries."
          },
          "language": {
            "type": "string",
            "minLength": 2,
            "maxLength": 10,
            "description": "For Google Play. The review language to read, such as en, es, de or pt-BR, since Google Play returns one language at a time. Without it, the link's hl is used, or en."
          }
        },
        "additionalProperties": false,
        "description": "A review page, by link or by platform and id. Its reviews become this keyword's mentions."
      },
      "maxItems": 10,
      "description": "Review pages for this keyword, at most 10 (App Store and Google Play apps, Trustpilot pages, Google Maps places). Every new review on them is a mention, whatever it says. Pages are read daily, per country on the app stores. A newly added page imports its last 30 days, up to 100 newest reviews per country, free and without instant alerts. Later reviews are billed like other mentions."
    }
  },
  "required": [
    "term"
  ],
  "additionalProperties": false
}

update_keyword

Changes a keyword. You can set its platforms (a list, or null for all), mute or unmute it, change its kind, or set its classifier context (null clears it). You can change its matching rules, where each field is optional and an empty list clears it, with requiredTerms and requiredMode any or all, excludedTerms with a `*` wildcard at either end, excludedAuthors and caseSensitive. You can set its monthly cap with cap: { mentions: N }, where null removes it and a cap above this month's count resumes a capped keyword right away. You can move it with groupId, which returns 409 if that group already has the term. You can set reviewSources, the full list of App Store, Google Play, Trustpilot or Google Maps pages, where an empty list disconnects them and a newly added app or country brings its last 30 days free. Rules only affect new mentions. Returns the keyword after the change, with its stats.

Parameters9

kind	string	optional	New kind (brand, competitor or topic).
muted	boolean	optional	Muting stops polling and matching. Existing mentions are kept.
platforms	any	optional	Sets a new platform list. Null means all platforms. An empty list means none, which works when the keyword has reviewSources and only collects reviews.
context	any	optional	Up to 300 characters the classifier reads for this keyword only, in addition to the company profile or the group's description. Say what the term means for you and what to ignore, for example "Driftwood is our deploy tool, not beach wood." Null clears it.
matching	object	optional	Fields you leave out stay as they are. An empty list clears a field.
cap	any	optional	Sets a new monthly mention cap, or null for no cap. A cap above this month's count resumes a capped keyword right away. A cap at or below the count pauses it.
groupId	string	optional	Target group (grp_...). 409 if it already has this term.
reviewSources	array	optional	Sets a new list of review pages for this keyword. An empty list disconnects them all, and their reviews are kept. A page or country you add gets the free 30-day look-back. Pages already listed are unchanged.
id	string	required	The keyword's id

Raw schema

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "brand",
        "competitor",
        "topic"
      ],
      "description": "New kind (brand, competitor or topic)."
    },
    "muted": {
      "type": "boolean",
      "description": "Muting stops polling and matching. Existing mentions are kept."
    },
    "platforms": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram"
            ]
          }
        },
        {
          "type": "null"
        }
      ],
      "description": "Sets a new platform list. Null means all platforms. An empty list means none, which works when the keyword has reviewSources and only collects reviews."
    },
    "context": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 300,
          "description": "Up to 300 characters the classifier reads for this keyword only, in addition to the company profile or the group's description. Say what the term means for you and what to ignore, for example \"Driftwood is our deploy tool, not beach wood.\" Null clears it."
        },
        {
          "type": "null"
        }
      ],
      "description": "Up to 300 characters the classifier reads for this keyword only, in addition to the company profile or the group's description. Say what the term means for you and what to ignore, for example \"Driftwood is our deploy tool, not beach wood.\" Null clears it."
    },
    "matching": {
      "type": "object",
      "properties": {
        "requiredTerms": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "maxItems": 50,
          "description": "Terms the post must contain as well. requiredMode says whether one or all of them must appear. An empty list sets no requirement."
        },
        "requiredMode": {
          "type": "string",
          "enum": [
            "any",
            "all"
          ],
          "description": "any needs one of the required terms in the post. all needs every one."
        },
        "excludedTerms": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "maxItems": 50,
          "description": "Posts that contain one of these terms are dropped. Put `*` at the start or end of a term as a wildcard, so deploy* matches deployment and *bot matches nightlybot."
        },
        "excludedAuthors": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
          },
          "maxItems": 100,
          "description": "Authors whose posts this keyword ignores. Each entry is a profile or post link, @handle, u/name, Bluesky DID or display name. Entries are normalized the same way as an alert's muted authors."
        },
        "caseSensitive": {
          "type": "boolean",
          "description": "When true, the term only matches in the exact case you typed, so RAG never matches rag. Defaults to false."
        }
      },
      "additionalProperties": false,
      "description": "Fields you leave out stay as they are. An empty list clears a field."
    },
    "cap": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "mentions": {
              "type": "integer",
              "minimum": 1,
              "maximum": 1000000,
              "description": "How many matched mentions the keyword may collect per calendar month (UTC). Every match counts, relevant or not, including a new keyword's look-back, since every match is billed."
            }
          },
          "required": [
            "mentions"
          ],
          "additionalProperties": false,
          "description": "The most mentions this keyword can match per month. At the cap it stops matching until the 1st of next month (UTC), or until the cap is raised or removed. It is not muted, so its daily charge continues. Mute it to stop that as well."
        },
        {
          "type": "null"
        }
      ],
      "description": "Sets a new monthly mention cap, or null for no cap. A cap above this month's count resumes a capped keyword right away. A cap at or below the count pauses it."
    },
    "groupId": {
      "type": "string",
      "minLength": 1,
      "description": "Target group (grp_...). 409 if it already has this term."
    },
    "reviewSources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500,
            "description": "Review page link, or send platform and id instead. Accepts App Store and Google Play app links (https://apps.apple.com/us/app/slack/id618783545, https://play.google.com/store/apps/details?id=com.Slack), Trustpilot pages (https://www.trustpilot.com/review/slack.com) and Google Maps places (full or maps.app.goo.gl link)."
          },
          "platform": {
            "type": "string",
            "enum": [
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "Where the reviews come from. appstore is the Apple App Store, googleplay is Google Play, trustpilot is a company's Trustpilot page and googlemaps is the Google reviews of a place."
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "description": "The platform's own id. On the App Store it is the number after \"id\" in the link, on Google Play the package name, on Trustpilot the company's domain (slack.com) and on Google Maps a Place ID (ChIJ...)."
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[A-Za-z]{2}$"
            },
            "minItems": 1,
            "maxItems": 20,
            "description": "For App Store and Google Play. Up to 20 storefronts to read, as two-letter codes. Without it, the storefront in the link is used, or us. Each storefront adds one poll a day, and a review found in two storefronts is still one mention. Trustpilot and Google Maps have a single page and take no countries."
          },
          "language": {
            "type": "string",
            "minLength": 2,
            "maxLength": 10,
            "description": "For Google Play. The review language to read, such as en, es, de or pt-BR, since Google Play returns one language at a time. Without it, the link's hl is used, or en."
          }
        },
        "additionalProperties": false,
        "description": "A review page, by link or by platform and id. Its reviews become this keyword's mentions."
      },
      "maxItems": 10,
      "description": "Sets a new list of review pages for this keyword. An empty list disconnects them all, and their reviews are kept. A page or country you add gets the free 30-day look-back. Pages already listed are unchanged."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The keyword's id"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "description": "Fields you leave out stay as they are."
}

get_analytics_summary

Returns summary counts for a period. Covers matched and relevant mentions, unique posts and people, sentiment, buying intent, questions, reach and triage. Reach sums followers where known. Triage gives open, ignored and done counts, mentions waiting over 24h, handled rate and median time to done. Set the period with range (7d, 30d, 90d or 365d, ending today) or from and to (YYYY-MM-DD). keywordIds and platforms take lists. timezone (IANA, default UTC) sets day boundaries. compare=true adds the prior period as `previous`. Dates are publish dates.

Parameters7

range	string	optional	A preset period up to today, 30d by default. Ignored when you send from or to.
from	string	optional	Start date in `timezone`, as YYYY-MM-DD. That day is included.
to	string	optional	End date in `timezone`, as YYYY-MM-DD, included. Defaults to today.
keywordIds	array	optional	Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords.
platforms	array	optional	Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms.
compare	boolean	optional	true adds the equally long period just before as `previous`.
timezone	string	optional	The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period.

Raw schema

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d",
        "365d"
      ],
      "description": "A preset period up to today, 30d by default. Ignored when you send from or to."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Start date in `timezone`, as YYYY-MM-DD. That day is included."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date in `timezone`, as YYYY-MM-DD, included. Defaults to today."
    },
    "keywordIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords."
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ]
      },
      "maxItems": 20,
      "description": "Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms."
    },
    "compare": {
      "type": "boolean",
      "description": "true adds the equally long period just before as `previous`."
    },
    "timezone": {
      "type": "string",
      "maxLength": 64,
      "description": "The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period."
    }
  },
  "additionalProperties": false
}

get_analytics_series

Counts matched, relevant and sentiment mentions per day or week (bucket, days by default up to 90 days). Returns one "total" series, or splits by="platform" or by="keyword" (top 20, rest as "other"). Period options match get_analytics_summary. compare=true adds `previous`, the prior period, aligned by index.

Parameters9

range	string	optional	A preset period up to today, 30d by default. Ignored when you send from or to.
from	string	optional	Start date in `timezone`, as YYYY-MM-DD. That day is included.
to	string	optional	End date in `timezone`, as YYYY-MM-DD, included. Defaults to today.
keywordIds	array	optional	Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords.
platforms	array	optional	Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms.
compare	boolean	optional	true adds the equally long period just before as `previous`.
timezone	string	optional	The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period.
bucket	string	optional	The size of each point. hour for periods up to 14 days, day, week (starting Monday) or month. By default days up to 90 days and weeks beyond.
by	string	optional	Splits the data into a series for each platform, each keyword or each sentiment (positive, neutral, negative, unclassified). By keyword you get the top 20 by matches, with the rest combined as "other". Leave it out for one total series.

Raw schema

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d",
        "365d"
      ],
      "description": "A preset period up to today, 30d by default. Ignored when you send from or to."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Start date in `timezone`, as YYYY-MM-DD. That day is included."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date in `timezone`, as YYYY-MM-DD, included. Defaults to today."
    },
    "keywordIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords."
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ]
      },
      "maxItems": 20,
      "description": "Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms."
    },
    "compare": {
      "type": "boolean",
      "description": "true adds the equally long period just before as `previous`."
    },
    "timezone": {
      "type": "string",
      "maxLength": 64,
      "description": "The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period."
    },
    "bucket": {
      "type": "string",
      "enum": [
        "hour",
        "day",
        "week",
        "month"
      ],
      "description": "The size of each point. hour for periods up to 14 days, day, week (starting Monday) or month. By default days up to 90 days and weeks beyond."
    },
    "by": {
      "type": "string",
      "enum": [
        "platform",
        "keyword",
        "sentiment"
      ],
      "description": "Splits the data into a series for each platform, each keyword or each sentiment (positive, neutral, negative, unclassified). By keyword you get the top 20 by matches, with the rest combined as \"other\". Leave it out for one total series."
    }
  },
  "additionalProperties": false
}

get_analytics_breakdown

Returns a table grouped by `by`. That is platform, keyword, sentiment, intent, status (open, ignored, done), hour (weekday and hour in timezone, to see when people post) or person (the most active authors, with followers). Each row has matched, relevant, its percentage of the period, a sentiment split and, with compare=true, the same row for the period just before. The period works as in get_analytics_summary. Up to 50 rows, the one with the most matches first.

Parameters8

range	string	optional	A preset period up to today, 30d by default. Ignored when you send from or to.
from	string	optional	Start date in `timezone`, as YYYY-MM-DD. That day is included.
to	string	optional	End date in `timezone`, as YYYY-MM-DD, included. Defaults to today.
keywordIds	array	optional	Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords.
platforms	array	optional	Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms.
compare	boolean	optional	true adds the equally long period just before as `previous`.
timezone	string	optional	The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period.
by	string	required	How to group the rows. platform, keyword, sentiment (unclassified included), intent (a mention can have several), status (open, ignored, done), hour (weekday and hour in `timezone`), person (the author, without anonymous posts) or language (ISO 639-1, or "unknown" when there is none).

Raw schema

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d",
        "365d"
      ],
      "description": "A preset period up to today, 30d by default. Ignored when you send from or to."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Start date in `timezone`, as YYYY-MM-DD. That day is included."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date in `timezone`, as YYYY-MM-DD, included. Defaults to today."
    },
    "keywordIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords."
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ]
      },
      "maxItems": 20,
      "description": "Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms."
    },
    "compare": {
      "type": "boolean",
      "description": "true adds the equally long period just before as `previous`."
    },
    "timezone": {
      "type": "string",
      "maxLength": 64,
      "description": "The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period."
    },
    "by": {
      "type": "string",
      "enum": [
        "platform",
        "keyword",
        "sentiment",
        "intent",
        "status",
        "hour",
        "person",
        "language"
      ],
      "description": "How to group the rows. platform, keyword, sentiment (unclassified included), intent (a mention can have several), status (open, ignored, done), hour (weekday and hour in `timezone`), person (the author, without anonymous posts) or language (ISO 639-1, or \"unknown\" when there is none)."
    }
  },
  "required": [
    "by"
  ],
  "additionalProperties": false
}

get_share_of_voice

Compares your brand with competitors. Returns each keyword with matches in the period, with matched, relevant, negative and buy-intent counts and its percentage of all brand and competitor matches. Topics are counted but not part of the split. The period works as in get_analytics_summary. compare=true adds each keyword's matches for the period just before.

Parameters7

range	string	optional	A preset period up to today, 30d by default. Ignored when you send from or to.
from	string	optional	Start date in `timezone`, as YYYY-MM-DD. That day is included.
to	string	optional	End date in `timezone`, as YYYY-MM-DD, included. Defaults to today.
keywordIds	array	optional	Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords.
platforms	array	optional	Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms.
compare	boolean	optional	true adds the equally long period just before as `previous`.
timezone	string	optional	The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period.

Raw schema

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d",
        "365d"
      ],
      "description": "A preset period up to today, 30d by default. Ignored when you send from or to."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Start date in `timezone`, as YYYY-MM-DD. That day is included."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date in `timezone`, as YYYY-MM-DD, included. Defaults to today."
    },
    "keywordIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords."
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ]
      },
      "maxItems": 20,
      "description": "Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms."
    },
    "compare": {
      "type": "boolean",
      "description": "true adds the equally long period just before as `previous`."
    },
    "timezone": {
      "type": "string",
      "maxLength": 64,
      "description": "The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period."
    }
  },
  "additionalProperties": false
}

get_reviews_report

Reports on the reviews your keywords collect from the App Store, Google Play, Trustpilot and Google over a period. Includes totals (reviews, average stars, star distribution, replies, open 1 and 2 star reviews), tags from unhappy reviews, and each review page's average stars per day or week (bucket). Two keywords matching one review count it once. Period options match get_analytics_summary, and compare=true adds the prior period.

Parameters8

range	string	optional	A preset period up to today, 30d by default. Ignored when you send from or to.
from	string	optional	Start date in `timezone`, as YYYY-MM-DD. That day is included.
to	string	optional	End date in `timezone`, as YYYY-MM-DD, included. Defaults to today.
keywordIds	array	optional	Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords.
platforms	array	optional	Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms.
compare	boolean	optional	true adds the equally long period just before as `previous`.
timezone	string	optional	The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period.
bucket	string	optional	The step of each series, day or week. Days by default for periods up to 90 days.

Raw schema

{
  "type": "object",
  "properties": {
    "range": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d",
        "365d"
      ],
      "description": "A preset period up to today, 30d by default. Ignored when you send from or to."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Start date in `timezone`, as YYYY-MM-DD. That day is included."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date in `timezone`, as YYYY-MM-DD, included. Defaults to today."
    },
    "keywordIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords."
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ]
      },
      "maxItems": 20,
      "description": "Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms."
    },
    "compare": {
      "type": "boolean",
      "description": "true adds the equally long period just before as `previous`."
    },
    "timezone": {
      "type": "string",
      "maxLength": 64,
      "description": "The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period."
    },
    "bucket": {
      "type": "string",
      "enum": [
        "day",
        "week"
      ],
      "description": "The step of each series, day or week. Days by default for periods up to 90 days."
    }
  },
  "additionalProperties": false
}

list_alerts

Returns every alert with its filter, mode, schedule and channels. The mode is instant, or hourly, daily or weekly for a digest.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

get_alert

Fetches an alert by id. Includes delivery stats as well as its filter, mode, schedule and channels.

Parameters1

string

required

The alert's id (feed_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The alert's id (feed_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

delete_alert

Deletes an alert. Its channels remain and other alerts can use them. This cannot be undone. To keep the alert, disable it with update_alert enabled=false instead.

Parameters1

string

required

The alert's id (feed_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The alert's id (feed_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

list_channels

Lists alert destinations (Slack channels, Telegram chats, email lists, webhooks). Connect Telegram chats in the dashboard under Settings, Integrations. The API can't.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

list_attention

Lists items that need a person, latest first. Kinds are mention.spike (mentions jumped in the last hour), sentiment.negative_spike (24-hour negative share jumped), keyword.noisy (turned noisy) and channel.failing (recent sends all failed). Checks run hourly, and items resolve when the condition ends. Open items by default, and status "all" adds the history. Items have a one-line title, numbers in data, and data.url to the dashboard.

Parameters4

status	string	optional	Which items to list. Defaults to open.
kinds	array	optional	Keeps these kinds only.
limit	integer	optional	Number of items, 50 if omitted.
cursor	string	optional	The nextCursor of the previous call.

Raw schema

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "open",
        "resolved",
        "dismissed",
        "all"
      ],
      "description": "Which items to list. Defaults to open."
    },
    "kinds": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "mention.spike",
          "sentiment.negative_spike",
          "keyword.noisy",
          "channel.failing"
        ],
        "description": "mention.spike flags an hour with far more mentions than usual, and sentiment.negative_spike a jump in the negative share over 24 hours. keyword.noisy flags a keyword whose scored matches are mostly noise, and channel.failing a channel whose recent sends all failed."
      },
      "maxItems": 4,
      "description": "Keeps these kinds only."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Number of items, 50 if omitted."
    },
    "cursor": {
      "type": "string",
      "description": "The nextCursor of the previous call."
    }
  },
  "additionalProperties": false
}

dismiss_attention

Moves an attention item (att_... from list_attention) out of the open list for as long as its condition lasts.

Parameters1

string

required

The attention item's id (att_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The attention item's id (att_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

create_alert

Creates an alert. mode "instant" sends each matching mention as it arrives. "hourly" sends a digest of the previous UTC hour at five past, skips hours with no mention above the minimum, and takes no schedule and no email channel (only Slack, Telegram and webhooks). "daily" sends one digest at schedule.hour in schedule.timezone. "weekly" sends one a week on schedule.weekday, from 0 for Sunday to 6 for Saturday. filter can use keywordIds, platforms, minRelevance, minConfidence, sentiments, intents, excludeAuthors, minFollowers, tags and linkHosts (hosts a post links to, including subdomains). Without minRelevance only relevant mentions (40 and up) are sent, and 0 sends every scored match, noise included. channelIds come from list_channels.

Parameters7

name	string	required
enabled	boolean	optional
mode	string	optional
filter	object	optional
schedule	object	optional	Daily and weekly alerts need it, and weekly ones need schedule.weekday too. Hourly alerts send every UTC hour, ignore a time or zone, and reject a weekday.
event	any	optional	Custom webhook event name. Null keeps the mode's default.
channelIds	array	optional	Where to send, as ids from GET /v1/channels.

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "enabled": {
      "type": "boolean",
      "default": true
    },
    "mode": {
      "type": "string",
      "enum": [
        "instant",
        "hourly",
        "daily",
        "weekly"
      ],
      "default": "instant"
    },
    "filter": {
      "type": "object",
      "properties": {
        "keywordIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Limits the rule to these keywords."
        },
        "groupIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Limits the rule to keywords in these groups (grp_...), for example one rule for each client."
        },
        "platforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "description": "Limits the rule to posts from these platforms."
        },
        "minRelevance": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100,
          "description": "The lowest relevance score the rule sends. Without it, only relevant mentions are sent, meaning a score of 40 or more. A lower value, down to 0, also sends matches the classifier rated as noise. A higher value sends fewer. Email channels always use 40, whatever the rule says. Mentions without a score are never sent."
        },
        "minConfidence": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "description": "Sends only mentions whose classifier confidence is this value or higher, from 0 to 1. Mentions without a confidence are left out."
        },
        "sentiments": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "positive",
              "neutral",
              "negative"
            ],
            "description": "The sentiment the classifier assigned."
          },
          "description": "Keeps mentions with these sentiments only."
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Sends only mentions with one or more of these intent or topic tags."
        },
        "excludeAuthors": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 200,
          "description": "Leaves out these authors, given as display names, handles or profile links."
        },
        "minFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "Sends only posts by authors with this many followers or more. Unknown counts are left out."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Keeps authors your workspace gave one of these tags."
        },
        "linkHosts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "Sends only posts that link to one of these hosts or its subdomains, so slack.com also matches api.slack.com. Posts without links are left out."
        },
        "languages": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z]{2}$"
          },
          "maxItems": 20,
          "description": "Sends only posts in these languages, as ISO 639-1 codes such as en, es or de. Posts with an unknown language are left out."
        },
        "automated": {
          "type": "boolean",
          "description": "true sends only posts that look machine-made, such as bot or template posts. false sends only the others. Leave it out to send both."
        },
        "ratings": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5
          },
          "maxItems": 5,
          "description": "Sends only reviews with one of these star ratings, from 1 to 5. Use [1, 2] for the unhappy ones. Posts that are not reviews are left out."
        },
        "notRatings": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5
          },
          "maxItems": 5,
          "description": "Star ratings (1 to 5) to skip, such as [5]. Other posts still go out."
        },
        "minLikes": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
        },
        "minReposts": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
        },
        "minReplies": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
        },
        "minQuotes": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
        },
        "minViews": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
        },
        "minBookmarks": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
        },
        "anyOf": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "q": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200,
                "description": "Searches post text and author names."
              },
              "keywordIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Keeps matches of these keywords only."
              },
              "notKeywordIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Keyword ids to exclude."
              },
              "keywordKinds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "brand",
                    "competitor",
                    "topic"
                  ]
                },
                "maxItems": 3,
                "description": "Keyword kinds to keep, out of brand, competitor and topic."
              },
              "groupIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Limits to keywords from these groups (grp_...)."
              },
              "notGroupIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Hides matches from keywords that belong to these groups."
              },
              "platforms": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "bluesky",
                    "hackernews",
                    "github",
                    "stackoverflow",
                    "devto",
                    "reddit",
                    "x",
                    "youtube",
                    "news",
                    "linkedin",
                    "tiktok",
                    "instagram",
                    "appstore",
                    "googleplay",
                    "trustpilot",
                    "googlemaps"
                  ],
                  "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
                },
                "maxItems": 20,
                "description": "Keeps posts from these platforms only."
              },
              "notPlatforms": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "bluesky",
                    "hackernews",
                    "github",
                    "stackoverflow",
                    "devto",
                    "reddit",
                    "x",
                    "youtube",
                    "news",
                    "linkedin",
                    "tiktok",
                    "instagram",
                    "appstore",
                    "googleplay",
                    "trustpilot",
                    "googlemaps"
                  ],
                  "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
                },
                "maxItems": 20,
                "description": "Platforms to exclude."
              },
              "status": {
                "type": "string",
                "enum": [
                  "open",
                  "ignored",
                  "done"
                ],
                "description": "Keeps mentions with this status only (open, ignored or done)."
              },
              "relevant": {
                "type": "boolean",
                "description": "Filter on the classifier's verdict. true keeps relevant mentions, false the rest."
              },
              "minRelevance": {
                "type": "integer",
                "minimum": 0,
                "maximum": 100,
                "description": "Minimum relevance score a mention needs."
              },
              "minConfidence": {
                "type": "number",
                "minimum": 0,
                "maximum": 1,
                "description": "Keeps mentions whose classifier confidence is this value or higher."
              },
              "sentiments": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "description": "The sentiment the classifier assigned."
                },
                "maxItems": 3,
                "description": "Keeps mentions with these sentiments only."
              },
              "notSentiments": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "description": "The sentiment the classifier assigned."
                },
                "maxItems": 3,
                "description": "Hides these sentiments. Unscored mentions stay."
              },
              "intents": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Keeps mentions tagged with one of these intents or topics."
              },
              "notIntents": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Hides mentions with these tags."
              },
              "automated": {
                "type": "boolean",
                "description": "true keeps posts that look machine-made. false keeps the others."
              },
              "languages": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z]{2}$"
                },
                "maxItems": 20,
                "description": "Keeps posts in these languages only, as ISO 639-1 codes."
              },
              "notLanguages": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z]{2}$"
                },
                "maxItems": 20,
                "description": "Leaves out posts in these languages. Posts with an unknown language are kept."
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Keeps authors your workspace gave one of these tags."
              },
              "notTags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Leaves out authors with one of these tags."
              },
              "linkHosts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 20,
                "description": "Keeps posts that link to one of these hosts or its subdomains."
              },
              "notLinkHosts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 20,
                "description": "Leaves out posts that link to these hosts."
              },
              "minFollowers": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps authors with this many followers or more. Unknown counts are left out."
              },
              "maxFollowers": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps authors with this many followers or fewer. Unknown counts are left out."
              },
              "isReply": {
                "type": "boolean",
                "description": "true keeps replies and comments. false keeps posts that are not replies."
              },
              "excludeAuthors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 200,
                "description": "Leaves out these authors, given as display names, handles or profile links."
              },
              "ratings": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "maxItems": 5,
                "description": "Keeps reviews with one of these star ratings. Posts that are not reviews are left out."
              },
              "notRatings": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "maxItems": 5,
                "description": "Hides reviews with these star ratings. Other posts are not affected."
              },
              "minLikes": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
              },
              "minReposts": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
              },
              "minReplies": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
              },
              "minQuotes": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
              },
              "minViews": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
              },
              "minBookmarks": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
              }
            },
            "additionalProperties": false,
            "description": "A set of conditions that must all be true. It uses the same fields as a view filter, except anyOf."
          },
          "minItems": 1,
          "maxItems": 10,
          "description": "Up to 10 OR'd groups (at least 1). A mention must meet every condition of some group, plus all other conditions, so the filter reads (other conditions) AND (group 1 OR group 2 ...). Groups take view filter fields (platforms, sentiments, intents, keywordKinds, the not lists and so on) but no nested anyOf."
        }
      },
      "additionalProperties": false,
      "default": {}
    },
    "schedule": {
      "type": "object",
      "properties": {
        "hour": {
          "type": "integer",
          "minimum": 0,
          "maximum": 23
        },
        "minute": {
          "type": "integer",
          "minimum": 0,
          "maximum": 59,
          "default": 0
        },
        "timezone": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "skipEmpty": {
          "type": "boolean",
          "default": true
        },
        "weekday": {
          "type": "integer",
          "minimum": 0,
          "maximum": 6,
          "description": "The day a weekly rule sends, from 0 for Sunday to 6 for Saturday. Required when mode is weekly and ignored for daily rules."
        }
      },
      "required": [
        "hour",
        "timezone"
      ],
      "additionalProperties": false,
      "description": "Daily and weekly alerts need it, and weekly ones need schedule.weekday too. Hourly alerts send every UTC hour, ignore a time or zone, and reject a weekday."
    },
    "event": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)*$",
          "maxLength": 60
        },
        {
          "type": "null"
        }
      ],
      "description": "Custom webhook event name. Null keeps the mode's default."
    },
    "channelIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "maxItems": 20,
      "default": [],
      "description": "Where to send, as ids from GET /v1/channels."
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

update_alert

Changes an alert's name, enabled, mode, schedule, filter or channelIds. filter and channelIds are replaced in full.

Parameters8

name	string	optional
enabled	boolean	optional
mode	string	optional
filter	object	optional	Sets the full new filter.
schedule	any	optional	For daily and weekly alerts. An hourly alert ignores it, but refuses a weekday.
event	any	optional
channelIds	array	optional	Sets the full new list.
id	string	required	The alert's id

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "enabled": {
      "type": "boolean"
    },
    "mode": {
      "type": "string",
      "enum": [
        "instant",
        "hourly",
        "daily",
        "weekly"
      ]
    },
    "filter": {
      "type": "object",
      "properties": {
        "keywordIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Limits the rule to these keywords."
        },
        "groupIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Limits the rule to keywords in these groups (grp_...), for example one rule for each client."
        },
        "platforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "bluesky",
              "hackernews",
              "github",
              "stackoverflow",
              "devto",
              "reddit",
              "x",
              "youtube",
              "news",
              "linkedin",
              "tiktok",
              "instagram",
              "appstore",
              "googleplay",
              "trustpilot",
              "googlemaps"
            ],
            "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
          },
          "description": "Limits the rule to posts from these platforms."
        },
        "minRelevance": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100,
          "description": "The lowest relevance score the rule sends. Without it, only relevant mentions are sent, meaning a score of 40 or more. A lower value, down to 0, also sends matches the classifier rated as noise. A higher value sends fewer. Email channels always use 40, whatever the rule says. Mentions without a score are never sent."
        },
        "minConfidence": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "description": "Sends only mentions whose classifier confidence is this value or higher, from 0 to 1. Mentions without a confidence are left out."
        },
        "sentiments": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "positive",
              "neutral",
              "negative"
            ],
            "description": "The sentiment the classifier assigned."
          },
          "description": "Keeps mentions with these sentiments only."
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Sends only mentions with one or more of these intent or topic tags."
        },
        "excludeAuthors": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 200,
          "description": "Leaves out these authors, given as display names, handles or profile links."
        },
        "minFollowers": {
          "type": "integer",
          "minimum": 0,
          "description": "Sends only posts by authors with this many followers or more. Unknown counts are left out."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40
          },
          "maxItems": 20,
          "description": "Keeps authors your workspace gave one of these tags."
        },
        "linkHosts": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20,
          "description": "Sends only posts that link to one of these hosts or its subdomains, so slack.com also matches api.slack.com. Posts without links are left out."
        },
        "languages": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z]{2}$"
          },
          "maxItems": 20,
          "description": "Sends only posts in these languages, as ISO 639-1 codes such as en, es or de. Posts with an unknown language are left out."
        },
        "automated": {
          "type": "boolean",
          "description": "true sends only posts that look machine-made, such as bot or template posts. false sends only the others. Leave it out to send both."
        },
        "ratings": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5
          },
          "maxItems": 5,
          "description": "Sends only reviews with one of these star ratings, from 1 to 5. Use [1, 2] for the unhappy ones. Posts that are not reviews are left out."
        },
        "notRatings": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5
          },
          "maxItems": 5,
          "description": "Star ratings (1 to 5) to skip, such as [5]. Other posts still go out."
        },
        "minLikes": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
        },
        "minReposts": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
        },
        "minReplies": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
        },
        "minQuotes": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
        },
        "minViews": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
        },
        "minBookmarks": {
          "type": "integer",
          "minimum": 0,
          "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
        },
        "anyOf": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "q": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200,
                "description": "Searches post text and author names."
              },
              "keywordIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Keeps matches of these keywords only."
              },
              "notKeywordIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Keyword ids to exclude."
              },
              "keywordKinds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "brand",
                    "competitor",
                    "topic"
                  ]
                },
                "maxItems": 3,
                "description": "Keyword kinds to keep, out of brand, competitor and topic."
              },
              "groupIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Limits to keywords from these groups (grp_...)."
              },
              "notGroupIds": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1
                },
                "maxItems": 50,
                "description": "Hides matches from keywords that belong to these groups."
              },
              "platforms": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "bluesky",
                    "hackernews",
                    "github",
                    "stackoverflow",
                    "devto",
                    "reddit",
                    "x",
                    "youtube",
                    "news",
                    "linkedin",
                    "tiktok",
                    "instagram",
                    "appstore",
                    "googleplay",
                    "trustpilot",
                    "googlemaps"
                  ],
                  "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
                },
                "maxItems": 20,
                "description": "Keeps posts from these platforms only."
              },
              "notPlatforms": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "bluesky",
                    "hackernews",
                    "github",
                    "stackoverflow",
                    "devto",
                    "reddit",
                    "x",
                    "youtube",
                    "news",
                    "linkedin",
                    "tiktok",
                    "instagram",
                    "appstore",
                    "googleplay",
                    "trustpilot",
                    "googlemaps"
                  ],
                  "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
                },
                "maxItems": 20,
                "description": "Platforms to exclude."
              },
              "status": {
                "type": "string",
                "enum": [
                  "open",
                  "ignored",
                  "done"
                ],
                "description": "Keeps mentions with this status only (open, ignored or done)."
              },
              "relevant": {
                "type": "boolean",
                "description": "Filter on the classifier's verdict. true keeps relevant mentions, false the rest."
              },
              "minRelevance": {
                "type": "integer",
                "minimum": 0,
                "maximum": 100,
                "description": "Minimum relevance score a mention needs."
              },
              "minConfidence": {
                "type": "number",
                "minimum": 0,
                "maximum": 1,
                "description": "Keeps mentions whose classifier confidence is this value or higher."
              },
              "sentiments": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "description": "The sentiment the classifier assigned."
                },
                "maxItems": 3,
                "description": "Keeps mentions with these sentiments only."
              },
              "notSentiments": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "description": "The sentiment the classifier assigned."
                },
                "maxItems": 3,
                "description": "Hides these sentiments. Unscored mentions stay."
              },
              "intents": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Keeps mentions tagged with one of these intents or topics."
              },
              "notIntents": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Hides mentions with these tags."
              },
              "automated": {
                "type": "boolean",
                "description": "true keeps posts that look machine-made. false keeps the others."
              },
              "languages": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z]{2}$"
                },
                "maxItems": 20,
                "description": "Keeps posts in these languages only, as ISO 639-1 codes."
              },
              "notLanguages": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z]{2}$"
                },
                "maxItems": 20,
                "description": "Leaves out posts in these languages. Posts with an unknown language are kept."
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Keeps authors your workspace gave one of these tags."
              },
              "notTags": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 40
                },
                "maxItems": 20,
                "description": "Leaves out authors with one of these tags."
              },
              "linkHosts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 20,
                "description": "Keeps posts that link to one of these hosts or its subdomains."
              },
              "notLinkHosts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 20,
                "description": "Leaves out posts that link to these hosts."
              },
              "minFollowers": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps authors with this many followers or more. Unknown counts are left out."
              },
              "maxFollowers": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps authors with this many followers or fewer. Unknown counts are left out."
              },
              "isReply": {
                "type": "boolean",
                "description": "true keeps replies and comments. false keeps posts that are not replies."
              },
              "excludeAuthors": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "maxItems": 200,
                "description": "Leaves out these authors, given as display names, handles or profile links."
              },
              "ratings": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "maxItems": 5,
                "description": "Keeps reviews with one of these star ratings. Posts that are not reviews are left out."
              },
              "notRatings": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "maxItems": 5,
                "description": "Hides reviews with these star ratings. Other posts are not affected."
              },
              "minLikes": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out."
              },
              "minReposts": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out."
              },
              "minReplies": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out."
              },
              "minQuotes": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out."
              },
              "minViews": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out."
              },
              "minBookmarks": {
                "type": "integer",
                "minimum": 0,
                "description": "Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out."
              }
            },
            "additionalProperties": false,
            "description": "A set of conditions that must all be true. It uses the same fields as a view filter, except anyOf."
          },
          "minItems": 1,
          "maxItems": 10,
          "description": "Up to 10 OR'd groups (at least 1). A mention must meet every condition of some group, plus all other conditions, so the filter reads (other conditions) AND (group 1 OR group 2 ...). Groups take view filter fields (platforms, sentiments, intents, keywordKinds, the not lists and so on) but no nested anyOf."
        }
      },
      "additionalProperties": false,
      "description": "Sets the full new filter."
    },
    "schedule": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "hour": {
              "type": "integer",
              "minimum": 0,
              "maximum": 23
            },
            "minute": {
              "type": "integer",
              "minimum": 0,
              "maximum": 59,
              "default": 0
            },
            "timezone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "skipEmpty": {
              "type": "boolean",
              "default": true
            },
            "weekday": {
              "type": "integer",
              "minimum": 0,
              "maximum": 6,
              "description": "The day a weekly rule sends, from 0 for Sunday to 6 for Saturday. Required when mode is weekly and ignored for daily rules."
            }
          },
          "required": [
            "hour",
            "timezone"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "For daily and weekly alerts. An hourly alert ignores it, but refuses a weekday."
    },
    "event": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)*$",
          "maxLength": 60
        },
        {
          "type": "null"
        }
      ]
    },
    "channelIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "maxItems": 20,
      "description": "Sets the full new list."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The alert's id"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "description": "Fields you leave out stay as they are."
}

mute_authors

Adds authors to an alert's muted list and keeps the rest of the filter. Entries can be profile or post links, @handles, u/names, Bluesky DIDs or display names. Links are stored as the author's profile. Authors already on the list are skipped, and entries that don't name a person are refused.

Parameters2

authors	array	required	A profile link (x.com/name, linkedin.com/in/name, reddit.com/user/name), post link, handle (@name, u/name), Bluesky DID or display name. Links are stored as the author's profile. A bare name or handle covers every platform.
id	string	required	The alert's id

Raw schema

{
  "type": "object",
  "properties": {
    "authors": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      },
      "minItems": 1,
      "maxItems": 50,
      "description": "A profile link (x.com/name, linkedin.com/in/name, reddit.com/user/name), post link, handle (@name, u/name), Bluesky DID or display name. Links are stored as the author's profile. A bare name or handle covers every platform."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The alert's id"
    }
  },
  "required": [
    "authors",
    "id"
  ],
  "additionalProperties": false,
  "description": "The authors to add to the alert's muted list, or take off it."
}

unmute_authors

Takes authors off an alert's muted list and keeps the rest of the filter. Each entry can be the stored value or a link to the person's profile or posts. Authors not on the list are skipped.

Parameters2

authors	array	required	A profile link (x.com/name, linkedin.com/in/name, reddit.com/user/name), post link, handle (@name, u/name), Bluesky DID or display name. Links are stored as the author's profile. A bare name or handle covers every platform.
id	string	required	The alert's id

Raw schema

{
  "type": "object",
  "properties": {
    "authors": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      },
      "minItems": 1,
      "maxItems": 50,
      "description": "A profile link (x.com/name, linkedin.com/in/name, reddit.com/user/name), post link, handle (@name, u/name), Bluesky DID or display name. Links are stored as the author's profile. A bare name or handle covers every platform."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The alert's id"
    }
  },
  "required": [
    "authors",
    "id"
  ],
  "additionalProperties": false,
  "description": "The authors to add to the alert's muted list, or take off it."
}

list_keywords

Lists the workspace's keywords with stats, polling status, matching rules and context, plus `total`. With no arguments you get all keywords, latest first. q searches the term and context. You can filter by kind, status (active, muted by someone, paused for balance, noisy when the noise brake paused it, or capped at its monthly mention cap), platform or groupId, order with sort, and page with limit and offset.

Parameters8

q	string	optional	Case-insensitive search in the term and context.
groupId	array	optional	Keeps keywords in these groups only (grp_...). Repeat the parameter or separate values with commas.
kind	array	optional	Keeps keywords of these kinds only (brand, competitor, topic). Repeat the parameter or separate values with commas.
status	array	optional	Keeps keywords in these states only (active, muted, paused, capped). Repeat the parameter or separate values with commas.
platform	array	optional	Keeps keywords that run on one of these platforms. That means the term is searched there, which is every platform when platforms is null. For appstore and googleplay it means an app from that store is in reviewSources. Repeat the parameter or separate values with commas.
sort	string	optional	newest puts the latest created first and oldest the earliest. term sorts A to Z. mentions puts the most matches first and relevant the most relevant matches. recent puts the most matches of the past 7 days first. lastMention puts the latest matched post first, with keywords that have none at the end.
limit	integer	optional	How many to return, from 1 to 500. Leave it out to get all keywords after `offset`.
offset	integer	optional	How many keywords to skip.

Raw schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Case-insensitive search in the term and context."
    },
    "groupId": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 50,
      "description": "Keeps keywords in these groups only (grp_...). Repeat the parameter or separate values with commas."
    },
    "kind": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "brand",
          "competitor",
          "topic"
        ]
      },
      "maxItems": 3,
      "description": "Keeps keywords of these kinds only (brand, competitor, topic). Repeat the parameter or separate values with commas."
    },
    "status": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "active",
          "muted",
          "paused",
          "noisy",
          "capped"
        ],
        "description": "active means it is running. muted means someone turned it off. paused means it stopped because the balance ran out. noisy means the noise brake stopped it, because most matches were irrelevant on a workspace still on its welcome credit. capped means it reached its monthly mention cap and waits for the next month."
      },
      "maxItems": 4,
      "description": "Keeps keywords in these states only (active, muted, paused, capped). Repeat the parameter or separate values with commas."
    },
    "platform": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ],
        "description": "The platform. Review platforms are appstore, googleplay, trustpilot and googlemaps (a place's Google reviews)."
      },
      "maxItems": 20,
      "description": "Keeps keywords that run on one of these platforms. That means the term is searched there, which is every platform when platforms is null. For appstore and googleplay it means an app from that store is in reviewSources. Repeat the parameter or separate values with commas."
    },
    "sort": {
      "type": "string",
      "enum": [
        "newest",
        "oldest",
        "term",
        "mentions",
        "relevant",
        "recent",
        "lastMention"
      ],
      "description": "newest puts the latest created first and oldest the earliest. term sorts A to Z. mentions puts the most matches first and relevant the most relevant matches. recent puts the most matches of the past 7 days first. lastMention puts the latest matched post first, with keywords that have none at the end.",
      "default": "newest"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "description": "How many to return, from 1 to 500. Leave it out to get all keywords after `offset`."
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "default": 0,
      "description": "How many keywords to skip."
    }
  },
  "additionalProperties": false
}

get_keyword

Fetches a keyword by id. Returns its setup (term, kind, platforms, matching rules, context, monthly cap, pausedForCap), its stats and how polling goes on each platform.

Parameters1

string

required

The keyword's id (kw_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The keyword's id (kw_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

get_keyword_health

Checks whether a keyword earns its cost, over range 7d, 30d or 90d (default 30d). Returns a status with plain-word reasons. noisy is 20+ scored matches with under 30% relevant, quiet is 7+ days old with nothing relevant, new is under 7 days old, and the rest are healthy, capped or paused. Also returns matches, relevant and noise share by platform and week, cost, the words and authors behind the noise, and suggestions. To apply one, pass its `patch` and the keyword id to update_keyword (lists replace the whole list). Its `effect` shows the noise and relevant matches and the cents the matcher's rules say it would have removed in the period. ai=true adds a model-written context (cached a day, 20 calls an hour per workspace). Read only, never billed, cached 5 minutes.

Parameters3

id	string	required	The keyword's id (kw_...)
range	string	optional	How far back from today to read. 7d, 30d (the default) or 90d.
ai	boolean	optional	true also asks a language model to rewrite the context. False by default.

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The keyword's id (kw_...)"
    },
    "range": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d"
      ],
      "description": "How far back from today to read. 7d, 30d (the default) or 90d."
    },
    "ai": {
      "type": "boolean",
      "description": "true also asks a language model to rewrite the context. False by default."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

delete_keyword

Stops monitoring a keyword and deletes its mentions, but keeps a post that another keyword also matched. Alerts that named it drop it, and an alert that named only this keyword is disabled instead of widening to all keywords. This cannot be undone. Muting with update_keyword muted=true keeps the mentions.

Parameters1

string

required

The keyword's id (kw_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The keyword's id (kw_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

whoami

Returns the workspace this credential works in, the kind of credential (an API key or an OAuth sign-in), whether it can write, and the signed-in user if there is one. Call it once when a session starts, to name the workspace and learn whether write tools will work.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

list_members

Lists workspace members with their role (owner, admin, member), email and user id. Use the user id for assigneeId in update_mention and ownerId in update_person.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

get_usage

Shows whether tracking is stopped or the balance is low, with the prepaid balance (ledger, pending mention charges, effective), daily spend and days left, running and balance-paused keywords, and matches today and over 30 days. Pricing is $0.008 per matched mention and $5 a month per active keyword, charged daily.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

get_usage_breakdown

Usage and charges for a period in US cents at list price, grouped by one `by` per call. keyword (default) gives days charged, mentions billed and totalCents per keyword, with deleted keywords marked keyword.removed=true. platform and day also work. Pick a trailing `range` (7d, 30d or 90d, default 30d) or a calendar `month` (YYYY-MM), which matches a bill or a per-client margin. Every call includes totals (keyword-days, matched and billed mentions, list-price total, actual ledger debits). Rows are paged (limit, offset, total). Use it for "what did keyword X cost". get_usage tells how much is left, and get_keyword has each keyword's month-to-date cost as stats.cost.

Parameters5

by	string	optional	How to group the rows. day gives one row per UTC day, then platform, keyword (the default, used to work out margins), or group (the cost of a client or campaign).
range	string	optional	How many UTC days back from today to read. One of 7d, 30d or 90d, 30d by default. Ignored when you send `month`.
month	string	optional	A calendar month (YYYY-MM, UTC) to read instead of a range. It covers the month's first to last day, or up to today for the current month. A future month returns 400.
limit	integer	optional	How many rows to return, from 1 to 500, 100 by default. Only by=keyword can need more than one page, since a period has at most 90 days and there are only a dozen platforms.
offset	integer	optional	How many rows to skip.

Raw schema

{
  "type": "object",
  "properties": {
    "by": {
      "type": "string",
      "enum": [
        "day",
        "platform",
        "keyword",
        "group"
      ],
      "default": "keyword",
      "description": "How to group the rows. day gives one row per UTC day, then platform, keyword (the default, used to work out margins), or group (the cost of a client or campaign)."
    },
    "range": {
      "type": "string",
      "enum": [
        "7d",
        "30d",
        "90d"
      ],
      "description": "How many UTC days back from today to read. One of 7d, 30d or 90d, 30d by default. Ignored when you send `month`."
    },
    "month": {
      "type": "string",
      "pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
      "description": "A calendar month (YYYY-MM, UTC) to read instead of a range. It covers the month's first to last day, or up to today for the current month. A future month returns 400."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "default": 100,
      "description": "How many rows to return, from 1 to 500, 100 by default. Only by=keyword can need more than one page, since a period has at most 90 days and there are only a dozen platforms."
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "default": 0,
      "description": "How many rows to skip."
    }
  },
  "additionalProperties": false
}

list_ledger

Shows the prepaid balance's history, latest first. Entries cover the welcome credit, top-ups, refunds, adjustments, and the daily keyword-day and mention debits. Debits carry their UTC settlement day and cumulative units. Cursor pages, limit up to 100. Funds are added on the dashboard's billing page or with POST /v1/billing/top-ups.

Parameters2

cursor	string	optional	The cursor of the previous page. Do not parse it.
limit	integer	optional	How many to return, 25 by default.

Raw schema

{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "description": "The cursor of the previous page. Do not parse it."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "How many to return, 25 by default."
    }
  },
  "additionalProperties": false
}

get_filters

Returns the workspace noise rules that run before any mention is stored, for every keyword. They exclude terms, authors and GitHub repositories, and allow or block subreddits. Rejected posts are never classified, sent or billed. Keywords add their own `matching` rules.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

update_filters

Changes the workspace filters. These are excludedTerms (`*` at either end is a wildcard), excludedAuthors (links, handles or names), excludedRepos (owner/name or a github.com link), subreddits.only (allowed subreddits, and when set, excluded is ignored) and subreddits.excluded. Every list is optional. A list you leave out stays as it is, and an empty list clears it. New mentions follow the change within a minute.

Parameters4

excludedTerms	array	optional	Sets a new list. An empty list clears it.
excludedAuthors	array	optional	Sets a new list. An empty list clears it.
excludedRepos	array	optional	Sets a new list. An empty list clears it.
subreddits	object	optional	Applies to Reddit only. A list you leave out stays as it is.

Raw schema

{
  "type": "object",
  "properties": {
    "excludedTerms": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "maxItems": 200,
      "description": "Sets a new list. An empty list clears it."
    },
    "excludedAuthors": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      },
      "maxItems": 200,
      "description": "Sets a new list. An empty list clears it."
    },
    "excludedRepos": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 200,
      "description": "Sets a new list. An empty list clears it."
    },
    "subreddits": {
      "type": "object",
      "properties": {
        "only": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "maxItems": 200,
          "description": "Sets a new list of allowed subreddits. An empty list clears it."
        },
        "excluded": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "maxItems": 200,
          "description": "Sets a new list of blocked subreddits. An empty list clears it."
        }
      },
      "additionalProperties": false,
      "description": "Applies to Reddit only. A list you leave out stays as it is."
    }
  },
  "additionalProperties": false,
  "description": "Fields you leave out stay as they are. An empty list clears a field."
}

get_company

Returns the company profile the classifier reads, with name, description, use cases, own accounts and the context text built from them for relevance scoring. A group with its own description replaces that text for its keywords (see list_groups).

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

update_company

Changes the company profile (name, description, useCases, accounts) or sets the classifier context yourself. Profile changes rebuild the context, and a context you set applies until the next profile change. The context affects relevance scores more than anything else, so keep it accurate and specific. It does not apply to keywords in a group with its own description, which you change with update_group. Fields you leave out stay as they are.

Parameters8

name	string	optional
description	string	optional
useCases	array	optional	Sets the full new list.
accounts	object	optional
website	any	optional	The company's website. Null removes it.
competitors	array	optional	Sets the full new list. An empty list clears it.
guidelines	any	optional	Rules for the classifier in your own words. Null removes them.
context	string	optional	Replaces the built context until the next profile change.

Raw schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "description": {
      "type": "string",
      "maxLength": 1000
    },
    "useCases": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Sets the full new list."
    },
    "accounts": {
      "type": "object",
      "properties": {
        "x": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 60
            },
            {
              "type": "null"
            }
          ]
        },
        "linkedin": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 200
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "website": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri",
          "maxLength": 300
        },
        {
          "type": "null"
        }
      ],
      "description": "The company's website. Null removes it."
    },
    "competitors": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      },
      "maxItems": 50,
      "description": "Sets the full new list. An empty list clears it."
    },
    "guidelines": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "null"
        }
      ],
      "description": "Rules for the classifier in your own words. Null removes them."
    },
    "context": {
      "type": "string",
      "maxLength": 4000,
      "description": "Replaces the built context until the next profile change."
    }
  },
  "additionalProperties": false,
  "description": "Fields you leave out stay as they are."
}

list_people

Lists the authors of mentions of your keywords. Each has name, profile, platform, how many posts matched and how many scored relevant, sentiment split, first and last seen, and outreach status (owner, stage, last contacted). You can filter by platform or name, find one person by handle or profile link (handle), and filter by outreach stage (stages), owner (ownerIds, or "none" for no owner) or automated (bots whose posts are mostly machine-made). Sort by mentions or by recency. To read what one person said, use search_mentions with personId.

Parameters24

platform	string	optional	Only people with a profile on this platform
q	string	optional	Searches the display name, handle and profile link
handle	string	optional	Looks up one person by an account, given as a handle (@sam, u/sam) or a profile or post link (https://x.com/sam). The match is exact but ignores case. Add platform to pick one platform
tag	string	optional	Keeps people with this tag
muted	boolean	optional	true keeps muted people and false people who are not muted. Leave it out for everyone
since	integer	optional	Keeps people whose first matched mention is at this time or later, as ISO 8601 or epoch ms. Use it to find new voices
sort	string	optional	"mentions" puts the most matches first, "recent" the most recently seen, "reach" the most followers, and "new" people seen for the first time most recently
segmentId	string	optional	Adds a saved segment's filter (from list_segments) to the other filters
platforms	array	optional	Keeps people with an account on one of these platforms
tags	array	optional	Keeps people with one of these tags
minFollowers	integer	optional	Keeps people with this many followers or more. Unknown counts are left out
maxFollowers	integer	optional
minMentions	integer	optional	Minimum number of matched mentions
minNegative	integer	optional	Minimum number of negative mentions
intents	array	optional	Has a mention tagged with one of these intents
keywordKinds	array	optional	Keeps people who mentioned a keyword of one of these kinds (brand, competitor, topic)
neverKeywordKinds	array	optional	Excludes people who mentioned these keyword kinds
newSinceDays	integer	optional	Keeps people first seen in the past this many days
automated	boolean	optional	true keeps people whose matched posts are mostly machine-made, such as bots. false keeps the others
linkHosts	array	optional	Keeps people with a mention that links to one of these hosts or its subdomains, so slack.com also matches api.slack.com
stages	array	optional	Only people in one of these outreach stages
ownerIds	array	optional	Keeps people owned by one of these members, by user id. Use "none" for people without an owner
limit	integer	optional
offset	integer	optional	How many people to skip, for paging

Raw schema

{
  "type": "object",
  "properties": {
    "platform": {
      "type": "string",
      "enum": [
        "bluesky",
        "hackernews",
        "github",
        "stackoverflow",
        "devto",
        "reddit",
        "x",
        "youtube",
        "news",
        "linkedin",
        "tiktok",
        "instagram",
        "appstore",
        "googleplay",
        "trustpilot",
        "googlemaps"
      ],
      "description": "Only people with a profile on this platform"
    },
    "q": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Searches the display name, handle and profile link"
    },
    "handle": {
      "type": "string",
      "minLength": 1,
      "maxLength": 300,
      "description": "Looks up one person by an account, given as a handle (@sam, u/sam) or a profile or post link (https://x.com/sam). The match is exact but ignores case. Add platform to pick one platform"
    },
    "tag": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40,
      "description": "Keeps people with this tag"
    },
    "muted": {
      "type": "boolean",
      "description": "true keeps muted people and false people who are not muted. Leave it out for everyone"
    },
    "since": {
      "type": "integer",
      "description": "Keeps people whose first matched mention is at this time or later, as ISO 8601 or epoch ms. Use it to find new voices"
    },
    "sort": {
      "type": "string",
      "enum": [
        "mentions",
        "recent",
        "reach",
        "new"
      ],
      "description": "\"mentions\" puts the most matches first, \"recent\" the most recently seen, \"reach\" the most followers, and \"new\" people seen for the first time most recently",
      "default": "mentions"
    },
    "segmentId": {
      "type": "string",
      "minLength": 1,
      "description": "Adds a saved segment's filter (from list_segments) to the other filters"
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bluesky",
          "hackernews",
          "github",
          "stackoverflow",
          "devto",
          "reddit",
          "x",
          "youtube",
          "news",
          "linkedin",
          "tiktok",
          "instagram",
          "appstore",
          "googleplay",
          "trustpilot",
          "googlemaps"
        ]
      },
      "maxItems": 20,
      "description": "Keeps people with an account on one of these platforms"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      },
      "maxItems": 20,
      "description": "Keeps people with one of these tags"
    },
    "minFollowers": {
      "type": "integer",
      "minimum": 0,
      "description": "Keeps people with this many followers or more. Unknown counts are left out"
    },
    "maxFollowers": {
      "type": "integer",
      "minimum": 0
    },
    "minMentions": {
      "type": "integer",
      "minimum": 1,
      "description": "Minimum number of matched mentions"
    },
    "minNegative": {
      "type": "integer",
      "minimum": 1,
      "description": "Minimum number of negative mentions"
    },
    "intents": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      },
      "maxItems": 10,
      "description": "Has a mention tagged with one of these intents"
    },
    "keywordKinds": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "brand",
          "competitor",
          "topic"
        ]
      },
      "maxItems": 3,
      "description": "Keeps people who mentioned a keyword of one of these kinds (brand, competitor, topic)"
    },
    "neverKeywordKinds": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "brand",
          "competitor",
          "topic"
        ]
      },
      "maxItems": 3,
      "description": "Excludes people who mentioned these keyword kinds"
    },
    "newSinceDays": {
      "type": "integer",
      "minimum": 1,
      "maximum": 365,
      "description": "Keeps people first seen in the past this many days"
    },
    "automated": {
      "type": "boolean",
      "description": "true keeps people whose matched posts are mostly machine-made, such as bots. false keeps the others"
    },
    "linkHosts": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Keeps people with a mention that links to one of these hosts or its subdomains, so slack.com also matches api.slack.com"
    },
    "stages": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "not_contacted",
          "contacted",
          "replied",
          "in_talks",
          "customer",
          "not_a_fit"
        ],
        "description": "The outreach stage your team has reached with this person."
      },
      "maxItems": 6,
      "description": "Only people in one of these outreach stages"
    },
    "ownerIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 20,
      "description": "Keeps people owned by one of these members, by user id. Use \"none\" for people without an owner"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "default": 0,
      "description": "How many people to skip, for paging"
    }
  },
  "additionalProperties": false
}

get_person

Returns one person from your audience with their counts, your tags, notes and mute, and their outreach status (owner, stage, last contacted). It also has their public profile where the platform shows one, with bio, company, location, website and linked accounts. profile.email is always null here. GitHub authors are looked up the same day, and profile is null until then.

Parameters1

string

required

The aut_... id from list_people, or author.id on a mention

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The aut_... id from list_people, or author.id on a mention"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

update_person

Changes your workspace's details on a person. You can set their full tag list, notes, mute, the outreach owner (ownerId, a member's user id, or null to remove) and stage. Muting hides their posts from the feed and all channels. Collection and billing do not change.

Parameters6

tags	array	optional	Sets the full new list.
notes	string	optional
muted	boolean	optional
ownerId	any	optional	The user id of the member responsible for this contact. Null removes it.
stage	string	optional	The outreach stage your team has reached with this person.
id	string	required	The person's id (aut_...)

Raw schema

{
  "type": "object",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      },
      "maxItems": 20,
      "description": "Sets the full new list."
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    },
    "muted": {
      "type": "boolean"
    },
    "ownerId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "description": "The user id of the member responsible for this contact. Null removes it."
    },
    "stage": {
      "type": "string",
      "enum": [
        "not_contacted",
        "contacted",
        "replied",
        "in_talks",
        "customer",
        "not_a_fit"
      ],
      "description": "The outreach stage your team has reached with this person."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The person's id (aut_...)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "description": "Fields you leave out stay as they are."
}

merge_people

Tells your workspace that two accounts are the same individual by merging account `id` into person `into`. Their mentions, tags and notes are combined, and the merged account appears among the person's platforms.

Parameters2

id	string	required	The account to merge (aut_...)
into	string	required	The person to merge it into (aut_...)

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The account to merge (aut_...)"
    },
    "into": {
      "type": "string",
      "minLength": 1,
      "description": "The person to merge it into (aut_...)"
    }
  },
  "required": [
    "id",
    "into"
  ],
  "additionalProperties": false
}

split_person

Reverses a merge, so the account is a separate person again in your workspace.

Parameters1

string

required

The aut_... id from list_people, or author.id on a mention

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The aut_... id from list_people, or author.id on a mention"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

list_activities

Shows who on the team has contacted a person, latest first. Each entry has the member, the channel, the time and a note. Channels are email, x, linkedin, bluesky, reddit, github, call, meeting and other. Look at this and the outreach owner before contacting someone, so teammates don't double up.

Parameters1

string

required

The aut_... id from list_people, or author.id on a mention

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The aut_... id from list_people, or author.id on a mention"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

log_activity

Logs that someone on the team contacted a person, for example by email, direct message or call. A not_contacted person moves to contacted, and a person with no owner gets the contacting member as owner. A later stage or an existing owner stays, and update_person changes them. memberId falls back to the signed-in user. Called with an API key and no memberId, it logs an activity without a member and sets no owner. Returns the new activity and the updated person.

Parameters5

channel	string	required	How the person was contacted.
note	string	optional	A short summary of what was sent or said.
occurredAt	integer	optional	Defaults to now. Otherwise send the contact time as ISO 8601 or epoch ms.
memberId	string	optional	The user id of the member who reached out. Defaults to the signed-in member. With an API key and no value, the activity has no member.
id	string	required	The aut_... id from list_people, or author.id on a mention

Raw schema

{
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "enum": [
        "email",
        "x",
        "linkedin",
        "bluesky",
        "reddit",
        "github",
        "call",
        "meeting",
        "other"
      ],
      "description": "How the person was contacted."
    },
    "note": {
      "type": "string",
      "maxLength": 2000,
      "default": "",
      "description": "A short summary of what was sent or said."
    },
    "occurredAt": {
      "type": "integer",
      "description": "Defaults to now. Otherwise send the contact time as ISO 8601 or epoch ms."
    },
    "memberId": {
      "type": "string",
      "minLength": 1,
      "description": "The user id of the member who reached out. Defaults to the signed-in member. With an API key and no value, the activity has no member."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The aut_... id from list_people, or author.id on a mention"
    }
  },
  "required": [
    "channel",
    "id"
  ],
  "additionalProperties": false
}

delete_activity

Deletes an outreach activity that was logged by mistake. The person keeps the same owner and stage.

Parameters2

id	string	required	The person's id (aut_...)
activityId	string	required	The activity's id (act_...) from list_activities

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The person's id (aut_...)"
    },
    "activityId": {
      "type": "string",
      "minLength": 1,
      "description": "The activity's id (act_...) from list_activities"
    }
  },
  "required": [
    "id",
    "activityId"
  ],
  "additionalProperties": false
}

get_mention_stats

Returns mention counts for the past N days (7 by default), by platform and by sentiment. You can limit it to one platform or keyword. Mentions without a score are counted under the sentiment "unclassified".

Parameters3

sinceDays	integer	optional	How many days back to count
platform	string	optional	Counts only this platform's mentions
keywordId	string	optional	Counts only the mentions of this keyword id

Raw schema

{
  "type": "object",
  "properties": {
    "sinceDays": {
      "type": "integer",
      "minimum": 1,
      "maximum": 365,
      "default": 7,
      "description": "How many days back to count"
    },
    "platform": {
      "type": "string",
      "enum": [
        "bluesky",
        "hackernews",
        "github",
        "stackoverflow",
        "devto",
        "reddit",
        "x",
        "youtube",
        "news",
        "linkedin",
        "tiktok",
        "instagram",
        "appstore",
        "googleplay",
        "trustpilot",
        "googlemaps"
      ],
      "description": "Counts only this platform's mentions"
    },
    "keywordId": {
      "type": "string",
      "description": "Counts only the mentions of this keyword id"
    }
  },
  "additionalProperties": false
}

README.md4 KBView on GitHub

Rumoro MCP server

Rumoro tracks what people say about your product, your competitors and your topics on Reddit, X, Hacker News, GitHub, YouTube, LinkedIn, Bluesky, Stack Overflow, DEV, TikTok, Instagram and news sites. Each mention is scored for relevance to your company.

The MCP server gives Claude, Cursor, Codex and any other MCP client access to your Rumoro workspace. Your agent can search and triage mentions, manage keywords and alerts, and read analytics, with 55 tools in total.

This repository holds the setup instructions and the server's MCP Registry entry. The server itself is hosted by Rumoro, so there is nothing to install or run.

Endpoint: https://mcp.rumoro.dev/mcp (streamable HTTP)
Docs: docs.rumoro.dev/mcp
Sign-in: OAuth in the browser, or an API key sent as a Bearer header
Registry name: dev.rumoro/mcp

Connect

You need a Rumoro account. Sign up at rumoro.dev; new accounts start with $5.80 of free credit.

Claude Code

bash

claude mcp add --transport http --scope user rumoro https://mcp.rumoro.dev/mcp

Then run /mcp in Claude Code, pick rumoro, choose Authenticate and approve in the browser.

Claude Desktop and claude.ai

Open Customize › Connectors, choose Add › Add custom connector, paste https://mcp.rumoro.dev/mcp and sign in.

Cursor

Add this to ~/.cursor/mcp.json, or to .cursor/mcp.json in one project:

json

{
  "mcpServers": {
    "rumoro": { "url": "https://mcp.rumoro.dev/mcp" }
  }
}

Cursor asks you to sign in the first time it uses the server.

Codex

bash

codex mcp add rumoro --url https://mcp.rumoro.dev/mcp
codex mcp login rumoro

Other clients

Any client that supports remote MCP servers over streamable HTTP can connect to https://mcp.rumoro.dev/mcp. Clients that support OAuth find the sign-in on their own.

With an API key

For CI, servers or clients without a browser, create a key on the API keys page of the Rumoro dashboard and export it as RUMORO_API_KEY.

bash

# Claude Code
claude mcp add --transport http rumoro https://mcp.rumoro.dev/mcp \
  --header "Authorization: Bearer $RUMORO_API_KEY"

# Codex
codex mcp add rumoro --url https://mcp.rumoro.dev/mcp \
  --bearer-token-env-var RUMORO_API_KEY

In Cursor, add a header to the entry:

json

"rumoro": {
  "url": "https://mcp.rumoro.dev/mcp",
  "headers": { "Authorization": "Bearer ${env:RUMORO_API_KEY}" }
}

Try it

Once connected, ask your agent something like:

"List the keywords I track in Rumoro"
"Show me this week's relevant mentions from Reddit and Hacker News"
"Which competitor got the most mentions this month?"

Pricing

Prepaid, with no subscription. $5 per keyword per month plus $0.008 per matched mention. See rumoro.dev/pricing.

Full documentation: docs.rumoro.dev
Setup guides for Claude, Cursor and Codex
TypeScript SDK: @rumoro-dev/sdk
Python SDK: rumoro
CLI: @rumoro-dev/cli

Support

If the server won't connect or a tool behaves unexpectedly, open an issue in this repository or email markus@rumoro.dev.

License

The setup guide and registry entry in this repository are released under the MIT License. The Rumoro service itself is covered by its terms.

Install

Tools (55)

list_segmentscreate_segmentupdate_segmentdelete_segmentlist_viewscreate_viewupdate_viewdelete_view

Remote endpoint

Streamable HTTP

Hosted server - connect over the network, no local install.

url

https://mcp.rumoro.dev/mcp

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.rumoro.dev/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.

dev.rumoro/mcp MCP Server

🛠️ Key Features

🚀 Use Cases

⚡ Developer Benefits

⚠️ Limitations

Topics

list_segments

create_segment

update_segment

delete_segment

list_views

create_view

update_view

delete_view

list_groups

get_group

create_group

update_group

delete_group

search_mentions

get_mention

update_mention

add_keyword

update_keyword

get_analytics_summary

get_analytics_series

get_analytics_breakdown

get_share_of_voice

get_reviews_report

list_alerts

get_alert

delete_alert

list_channels

list_attention

dismiss_attention

create_alert

update_alert

mute_authors

unmute_authors

list_keywords

get_keyword

get_keyword_health

delete_keyword

whoami

list_members

get_usage

get_usage_breakdown

list_ledger

get_filters

update_filters

get_company

update_company

list_people

get_person

update_person

merge_people

split_person

list_activities

log_activity

delete_activity

get_mention_stats

Rumoro MCP server

Connect

Claude Code

Claude Desktop and claude.ai

Cursor

Codex

Other clients

With an API key

Try it

Pricing

More

Support

License

Install

Remote endpoint

Related servers