OverviewPlatformsAPI Reference
Mentions

Export mentions as JSON

Returns in one response the mentions GET /v1/mentions lists for the same filters, latest match first, which is the order they reached your feed. Each row is the full Mention object from the list, text included. At most 10,000 mentions are returned, and truncated tells you when some were cut. It shares the CSV export's limit of 6 exports a minute per workspace, in either format, and a 429 includes Retry-After.

GET
/v1/mentions/export.json

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Query Parameters

keywordId?string

Only this keyword's matches.

platform?string

Only this platform's posts.

Value in

  • "bluesky"
  • "hackernews"
  • "github"
  • "stackoverflow"
  • "devto"
  • "reddit"
  • "x"
  • "youtube"
  • "news"
  • "linkedin"
  • "tiktok"
  • "instagram"
  • "appstore"
  • "googleplay"
  • "trustpilot"
  • "googlemaps"
status?string

Keeps mentions with this status only. Leave it out for all statuses.

Value in

  • "open"
  • "ignored"
  • "done"
relevant?boolean

true keeps mentions the classifier scored relevant. false keeps the others, including unscored ones.

sentiment?string

Keeps mentions with this sentiment only.

Value in

  • "positive"
  • "neutral"
  • "negative"
intent?string

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

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

Keeps mentions by this person (an id from /v1/people), including merged accounts. Turns on includeMuted.

Length1 <= length
includeMuted?boolean

true also returns mentions by muted people, which are hidden by default.

assigneeId?string

Member user id. Returns only mentions assigned to them.

Length1 <= length
snoozed?boolean

true shows only snoozed mentions, which are otherwise hidden until they wake.

excludeAuthors?array<>|

Leaves out these authors, given as display names, handles or profile links. Repeat the parameter or send one value with commas.

Itemsitems <= 200
minRelevance?|

Keeps mentions with this relevance score or higher. Unscored mentions are left out.

Range0 <= value <= 100
minConfidence?|

Minimum classifier confidence, 0 to 1. Mentions with no confidence are dropped.

Range0 <= value <= 1
minFollowers?|

Sends only posts by authors with this many followers or more. Unknown counts are left out.

Range0 <= value
maxFollowers?|

Keeps posts by authors with this many followers or fewer. Unknown counts are left out.

Range0 <= value
isReply?boolean

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

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.

Length1 <= length
viewId?string

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.

Length1 <= length
keywordKinds?array<>

Keeps matches of keywords of these kinds only (brand, competitor, topic). Repeat the parameter or separate values with commas.

Itemsitems <= 3
tags?array<>|

Keeps authors your workspace gave one of these tags, matched exactly and by case. Repeat the parameter or separate values with commas.

Itemsitems <= 20
linkHosts?array<>|

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.

Itemsitems <= 20
platforms?array<>

Keeps posts from these platforms only.

Itemsitems <= 20
notPlatforms?array<>

Platforms to exclude.

Itemsitems <= 20
keywordIds?array<>|

Keeps matches of these keywords only.

Itemsitems <= 50
groupIds?array<>|

Keeps matches of keywords in these groups only (grp_...). Repeat the parameter or separate values with commas.

Itemsitems <= 50
notGroupIds?array<>|

Hides matches from keywords that belong to these groups.

Itemsitems <= 50
notKeywordIds?array<>|

Keyword ids to exclude.

Itemsitems <= 50
sentiments?array<>

Keeps mentions with these sentiments only.

Itemsitems <= 3
notSentiments?array<>

Leaves out these sentiments. Mentions not scored yet are kept.

Itemsitems <= 3
intents?array<>|

Keeps mentions tagged with one of these intents or topics.

Itemsitems <= 20
notIntents?array<>|

Intent or topic tags to exclude.

Itemsitems <= 20
notLinkHosts?array<>|

Leaves out posts that link to these hosts or their subdomains.

Itemsitems <= 20
notTags?array<>|

Leaves out authors your workspace gave one of these tags.

Itemsitems <= 20
languages?array<>

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.

Itemsitems <= 20
notLanguages?array<>

Leaves out posts in these languages. Posts with an unknown language are kept.

Itemsitems <= 20
ratings?array<>

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.

Itemsitems <= 5
notRatings?array<>

Star ratings (1 to 5) to hide, such as notRatings=5. Other posts are unaffected.

Itemsitems <= 5
minLikes?|

Keeps posts with this many likes (upvotes, reactions) or more, counted when the post was collected. Posts without a like count are left out.

Range0 <= value
minReposts?|

Keeps posts with this many reposts (shares, retweets) or more, counted when the post was collected. Posts without a repost count are left out.

Range0 <= value
minReplies?|

Keeps posts with this many replies (comments) or more, counted when the post was collected. Posts without a reply count are left out.

Range0 <= value
minQuotes?|

Keeps posts with this many quotes or more, counted when the post was collected. Posts without a quote count are left out.

Range0 <= value
minViews?|

Keeps posts with this many views (plays) or more, counted when the post was collected. Posts without a view count are left out.

Range0 <= value
minBookmarks?|

Keeps posts with this many bookmarks (saves) or more, counted when the post was collected. Posts without a bookmark count are left out.

Range0 <= value
anyOf?string

Groups of conditions joined by OR, as URL-encoded JSON. For example [{"platforms":["github"],"intents":["bug_report"]},{"sentiments":["negative"]}] means "bug reports on GitHub, or anything negative". A group uses the fields of a view filter, where a list matches any value, a not list matches none, and all conditions are joined by AND. A mention passes when one group matches, and the other filters here still apply. Send 1 to 10 groups, none empty and none nested.

q?string

Searches post text and author names.

since?string

Keeps posts published at this time or later, as ISO 8601 or epoch ms.

Formatdate-time
until?string

Keeps posts published at this time or earlier, as ISO 8601 or epoch ms.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/mentions/export.json"
{  "data": [    {      "id": "string",      "status": "open",      "relevant": true,      "delivered": true,      "priority": 0,      "keyword": {        "id": "string",        "term": "string",        "group": {          "id": "string",          "name": "string",          "externalId": "string",          "isDefault": true        }      },      "post": {        "platform": "bluesky",        "url": "string",        "text": "string",        "title": "string",        "imageUrl": "string",        "links": [          "string"        ],        "publishedAt": "string",        "engagement": {          "likes": 0,          "reposts": 0,          "replies": 0,          "quotes": 0,          "views": 0,          "bookmarks": 0        },        "replyTo": {          "author": "string",          "url": "string",          "text": "string"        }      },      "author": {        "id": "string",        "name": "string",        "handle": "string",        "url": "string",        "avatarUrl": "string",        "followers": 0,        "tags": [          "string"        ]      },      "review": {        "rating": 1,        "ratingMax": 0,        "title": "string",        "version": "string",        "country": "string",        "verified": true,        "response": "string",        "responseAt": "string",        "app": {          "platform": "appstore",          "id": "string",          "url": "string"        }      },      "classification": {        "relevance": 0,        "sentiment": "positive",        "intents": [          "string"        ],        "automated": true,        "language": "string",        "confidence": 0,        "uncertain": true,        "note": "string",        "failed": true,        "feedback": {          "relevant": true,          "sentiment": "positive",          "at": "string",          "original": {            "relevance": 0,            "sentiment": "positive"          }        }      },      "triage": {        "assignee": {          "id": "string",          "name": "string",          "email": "string"        },        "snoozedUntil": "string",        "note": "string"      },      "createdAt": "string"    }  ],  "truncated": true}
Was this page helpful?

Export mentions as CSV

Returns as CSV the mentions GET /v1/mentions lists for the same filters. Rows are ordered by match time, latest first, which is the order they reached your feed and can differ from the post date. The columns are id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (separated by |), language, confidence, status, relevant, delivered, url, links (separated by |), text (the first 1,000 characters), group, group_external_id, rating and app_id (reviews only), and title and image_url (on platforms that have them). The file holds at most 10,000 rows, and the X-Mentions-Truncated header tells you when rows were cut. Each workspace can export 6 times a minute, and a 429 includes Retry-After.

Get a mention

Fetches one mention by id, with the same fields the list returns. An id from another workspace gets a 404.