Keywords

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.

get/v1/keywords

Request

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

Query parameters

qstring

Case-insensitive search in the term and context.

groupIdstring[] nullable

Keeps keywords in these groups only (grp_...). Repeat the parameter or separate values with commas.

kindstring[]

Keeps keywords of these kinds only (brand, competitor, topic). Repeat the parameter or separate values with commas.

statusstring[]

Keeps keywords in these states only (active, muted, paused, capped). Repeat the parameter or separate values with commas.

platformstring[]

Keeps 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.

sort'newest' | 'oldest' | 'term' | 'mentions' | 'relevant' | 'recent' | 'lastMention'

newest 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.

limitinteger

How many to return, from 1 to 500. Leave it out to get all keywords after offset.

offsetinteger nullable

How many keywords to skip.

Response

The keywords that match, with their total

totalinteger required

Count of matching keywords, ignoring limit and offset.

Changes

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