List prompts

GET/v1/prompts

The questions tracked for a brand, newest first.

Read-onlyAll plans

Query parameters

brand_idstringoptionalThe brand to read. Optional when your key covers one brand; required for agency keys and when trying the API signed in.

topic_idstringoptionalOnly prompts in this topic (top_…).

trackedbooleanoptionaltrue for tracked prompts only, false for untracked. Default: both.

limitintegeroptionalHow many items to return, 1 to 100. Default 20.

cursorstringoptionalThe next_cursor from the previous page.

A list of prompt objects.

objectstringAlways list.

dataarray of objectsThe items.

idstringPrompt id, prm_….

textstringThe question as asked.

topicobject or nullid and name of its topic.

intentstringinformational, commercial or comparison.

trackedbooleanWhether it’s asked in daily scans.

createddatetimeWhen it was added.

has_morebooleanWhether there is another page.

next_cursorstring or nullPass as cursor to get the next page.

401unauthorizedMissing or revoked API key.

404not_foundNo brand with that id that this key can read.

429rate_limitedToo many requests; see Retry-After.