Keywords

List keywords

The keywords of the workspace with their match stats and poll health. Without parameters: every keyword, newest first. q searches the term and the context; kind, status and platform narrow the list; sort orders it; limit and offset page it. total counts the keywords that matched before paging.

get/v1/keywords

Request

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

Query parameters

qstring

Text to find in the term or in the keyword's context, case-insensitive.

groupIdstring[] nullable

Only keywords in any of these groups (grp_...). Repeatable, or comma-separated.

kindstring[]

Only these kinds: brand, competitor, topic. Repeatable, or comma-separated.

statusstring[]

Only keywords in these states: active, muted, paused, capped. Repeatable, or comma-separated.

platformstring[]

Only keywords tracked on any of these platforms: its term searched there (every platform when its platforms are null), or for appstore and googleplay, an app of that store among its reviewSources. Repeatable, or comma-separated.

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

newest: created most recently first. oldest: the reverse. term: A to Z. mentions: most matches first. relevant: most relevant matches first. recent: most matches in the last 7 days first. lastMention: newest matched post first, keywords with none last.

limitinteger

Page size, 1 to 500. Omit for every keyword after offset.

offsetinteger nullable

Skip this many keywords.

Response

The matching keywords and how many there are

totalinteger required

Keywords matching the filters, before limit and offset.

Changes

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