Keywords

Track a keyword

Start tracking a word or phrase. Matching, classification and delivery begin on the next poll. A funded workspace tracks up to 500 keywords; each costs $5 per month, deducted daily from the balance. matching narrows what the term matches (required and excluded terms, excluded authors, case, subreddits, GitHub repository events) before a mention is stored, so a rejected post is never billed; context is a sentence the classifier reads for this keyword only. cap puts a monthly ceiling on its matched mentions: at the cap it stops matching until the first of the next month (UTC) or until the cap is raised, while its daily keyword charge continues.

post/v1/keywords

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/keywords
  • Auth: HTTP bearer

Request body

termstring required

The word or phrase to track, case-insensitive. A multi-word term matches as the phrase or as its words close together (see matching.exactPhrase); wrap it in double quotes for the exact phrase only.

kind'brand' | 'competitor' | 'topic'

brand: your own names. competitor: theirs. topic: the space. Drives share of voice and segments.

platformsstring[] nullable

Platforms to search the term on; omit or null for every platform. [] searches it nowhere: a keyword that only collects reviews or reads feeds, which then needs reviewSources or feeds.

contextstring nullable

A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.

groupIdstring

The group to track it in (grp_...); omit for the workspace's default group. A term may be tracked once per group.

readsWorkspaceFeedsboolean

Whether the keyword also reads the workspace's feeds (GET /v1/feeds); default true. A new keyword reading them gets the look-back of the 8 most recently connected.

Response

The created keyword

idstring required

Keyword id (kw_...).

termstring required
kind'brand' | 'competitor' | 'topic' required
mutedboolean required

Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).

pausedForBalanceboolean required

Muted by the wallet for lack of balance; a top-up resumes it, unmuting by hand needs balance too.

pausedForNoiseboolean required

Muted by the noise brake: on a workspace running on its welcome credit, at least 20 of its matches were scored and under 30% were relevant. A change of its required or excluded terms, platforms or context resumes it (when the balance covers another day), and so does unmuting; a top-up does not.

pausedForCapboolean required

At its monthly mention cap: not matched until the first of next month (UTC) or until the cap is raised. Not muted: it keeps its place and its daily keyword charge.

platformsstring[] nullable required

Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).

readsWorkspaceFeedsboolean required

true (the default): the keyword also reads every feed of the workspace (GET /v1/feeds), on top of its own feeds. false: its own feeds alone.

contextstring nullable required

A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.

createdAtstring required

ISO 8601 timestamp, UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.