Keywords

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. feeds reads RSS or Atom feeds (a feed's address or a site's), checked when saved and read every hour; platforms: [] with review pages or feeds tracks only those.

post/v1/keywords

Request

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

Request body

termstring required

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

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

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

platformsstring[] nullable

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.

contextstring nullable

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.

groupIdstring

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

Response

The new 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.