List keywords
Returns the workspace's keywords with their match counts and polling status. With no parameters you get all keywords, latest first. q searches the term and context. kind, status and platform filter the list, sort orders it, and limit and offset page through it. total is the number of matching keywords before paging.
Authorization
bearerAuth An API key from POST /v1/api-keys. Keys start with ref_.
In: header
Query Parameters
Case-insensitive search in the term and context.
1 <= length <= 200Keeps keywords in these groups only (grp_...). Repeat the parameter or separate values with commas.
items <= 50Keeps keywords of these kinds only (brand, competitor, topic). Repeat the parameter or separate values with commas.
items <= 3Keeps keywords in these states only (active, muted, paused, capped). Repeat the parameter or separate values with commas.
items <= 4Keeps 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.
items <= 20newest 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.
"newest"Value in
- "newest"
- "oldest"
- "term"
- "mentions"
- "relevant"
- "recent"
- "lastMention"
How many to return, from 1 to 500. Leave it out to get all keywords after offset.
1 <= value <= 500How many keywords to skip.
0 <= value0Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/keywords"{ "data": [ { "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" } ], "total": 0}Get a keyword
Returns one keyword with its matching rules, review pages, this month's cost and the polling status on each platform.
Update a keyword
Mutes or unmutes the keyword, or changes its `kind`, platforms, classifier `context`, `matching` rules or monthly mention `cap`. Each rule field is optional and an empty list clears it. A null cap removes the cap, and a cap above this month's count resumes a capped keyword right away. New rules apply to mentions from the next poll on. Stored mentions stay as they are.