OverviewPlatformsAPI Reference
Mentions

Update a mention

The only way to change a mention. Set status to ignored or done when it is handled, or back to open. You can also assign it to a member, snooze it out of the feed, add a note for your team, or correct the classifier. relevant true or false is your judgment, which sets relevance to 100 or 0 for every list, filter, digest and report. sentiment replaces the label. Null removes your correction and brings back the classifier's value. Fields you leave out stay as they are. Delivery and billing are never affected.

PATCH
/v1/mentions/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Mention id (mm_...).

Length1 <= length

Request Body

application/json

All fields are optional. Fields you leave out stay as they are.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/mentions/mm_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}
Was this page helpful?

List mentions

Lists your keywords' mentions with filters and paging. Each mention pairs one post with one keyword. Latest match first by default, or sort=priority to rank the last 30 days by attention score. For the next page, send nextCursor and keep the filters and sort. alertId applies an alert's filter, giving what that alert would send. anyOf adds OR groups as URL-encoded JSON, at least one of which must match along with every other filter.

Get the company profile

Returns what the classifier knows about your company. That is the name, description, use cases and your accounts, plus the context text built from them.