Keywords

Get a keyword

Returns one keyword with its matching rules, review pages, this month's cost and the polling status on each platform.

get/v1/keywords/{id}

Request

  • Base URL: https://api.rumoro.dev
  • URL: https://api.rumoro.dev/v1/keywords/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The keyword's id (kw_...).

Example:kw_abc123

Response

The requested keyword

idstring required

The keyword's id (kw_...).

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

True when the keyword is neither polled nor matched. You, the wallet (pausedForBalance) or the noise brake (pausedForNoise) can mute it. Reaching the mention cap does not mute it (pausedForCap).

pausedForBalanceboolean required

Muted because the balance ran out. A top-up resumes it. Unmuting it yourself also needs balance.

pausedForNoiseboolean required

Set when the noise brake muted the keyword. That happens on welcome credit once 20 or more matches are scored and under 30% are relevant. Unmuting it, or changing its required or excluded terms, platforms or context, resumes it when the balance covers another day. A top-up alone does not.

pausedForCapboolean required

Hit its monthly mention cap. Matching resumes on the 1st (UTC) or when you raise the cap. The keyword isn't muted and is still charged daily.

platformsstring[] nullable required

The platforms searched for the term. Null means all of them. An empty list means none, and the keyword only collects reviews.

contextstring nullable required

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 "Basil is our deploy tool, not the herb." Null clears it.

createdAtstring required

UTC time in ISO 8601.

Changes

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