Create a keyword

Starts monitoring a word or phrase. Matching, scoring and delivery start with the next poll. A workspace with balance can have up to 500 keywords, each costing $5 a month, taken from the balance day by day. matching narrows what counts as a match, with required and excluded terms, excluded authors and case, before anything is stored, so rejected posts are never billed. context is a sentence only this keyword's classifier reads. cap limits matched mentions per month. At the cap the keyword stops matching until the 1st of next month (UTC) or until you raise the cap, and its daily charge continues.

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Request Body

application/json

term*string

The word or phrase to monitor. It matches as a whole phrase, ignoring case.

Length2 <= length <= 80

kind?string

brand is for your own names, competitor for a rival's, and topic for your market. Share of voice and segments use it.

Default"brand"

Value in

"brand"
"competitor"
"topic"

platforms?array<>|

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?|

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.

Lengthlength <= 300

matching?

Fields you leave out stay as they are. An empty list clears a field.

cap?|

Monthly limit on matched mentions. Omit or null means none.

groupId?string

The group to put it in (grp_...). Without it, the workspace's default group is used. Each group can hold a term only once.

Length1 <= length

reviewSources?array<>

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.

Itemsitems <= 10

Response Body

`application/json`

curl -X POST "https://example.com/v1/keywords" \  -H "Content-Type: application/json" \  -d '{    "term": "string"  }'

{  "id": "string",  "term": "string",  "kind": "brand",  "muted": true,  "pausedForBalance": true,  "pausedForNoise": true,  "pausedForCap": true,  "cap": {    "mentions": 1,    "welcome": true,    "own": 0  },  "group": {    "id": "string",    "name": "string",    "externalId": "string",    "isDefault": true  },  "platforms": [    "bluesky"  ],  "reviewSources": [    {      "platform": "appstore",      "id": "string",      "url": "string",      "countries": [        "string"      ],      "language": "string",      "connectedAt": "string"    }  ],  "context": "string",  "matching": {    "requiredTerms": [      "string"    ],    "requiredMode": "any",    "excludedTerms": [      "string"    ],    "excludedAuthors": [      "string"    ],    "caseSensitive": true  },  "stats": {    "mentions": 0,    "relevant": 0,    "last7d": 0,    "thisMonth": 0,    "lastMentionAt": "string",    "feedback": {      "relevant": 0,      "notRelevant": 0    },    "noise": {      "scored": 0,      "relevant": 0,      "noisy": true    },    "health": "healthy",    "cost": {      "keywordDays": 0,      "keywordCents": 0,      "billableMentions": 0,      "mentionCents": 0,      "totalCents": 0    }  },  "polling": [    {      "platform": "bluesky",      "lastPolledAt": "string",      "emptyPolls": 0    }  ],  "createdAt": "string"}

Create a keyword

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

401application/json

402application/json

409application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`