Sign in

v1

latestOpenAPI 3.0.12026-07-2318588.1 KB
Prompts

List Prompts

Questions are the AI prompts that can be asked about a brand. They are used to get AI answers with citations and mentions.

post/public_api/brand_kits/{brand_kit_id}/prompts/list

Path parameters

brand_kit_idinteger required

The Brand Kit ID

Request body

brand_kit_idinteger required

The ID of the Brand Kit

start_datestring

Start date for metrics (ISO 8601). Defaults to 1 month ago.

end_datestring

End date for metrics (ISO 8601). Defaults to today.

providersstring[]

Filter metrics by AI providers

countriesstring[]

Filter metrics by country codes

personasinteger[]

Filter metrics by persona IDs

includesstring[]

Include related resources.

Available includes:

  • topic: Include the associated topic
  • tags: Include the associated tags
fieldsstring[]

Select additional fields to return.

Optional fields:

  • id: Unique identifier for the prompt
  • text: The prompt text
  • keyword: Associated keyword for the prompt
  • brand_mentioned: Whether the brand is mentioned in the prompt
  • prompt_volume: Prompt volume level
  • topic_id: ID of the associated topic
  • created_at: When the prompt was created
  • updated_at: When the prompt was last updated
  • mention_rate: Percentage of AI answers mentioning the brand (0-100)
  • citation_rate: Percentage of AI answers citing the brand (0-100)
  • mention_rate_trend: Change in mention_rate vs previous period
  • citation_rate_trend: Change in citation_rate vs previous period
  • query_fanouts: Search queries the AI ran internally when answering this question. Each entry has text (the raw query), normalized_text (lowercase/trimmed), and observations_count (how many times it appeared — higher = stronger signal). Empty if query fanout capture is not enabled for your workspace or if we do not support it for this provider.
  • countries: ISO alpha-2 country codes currently assigned to the prompt (live).
  • persona_ids: IDs of personas currently assigned to the prompt (live). Use list_personas to resolve to titles.
  • platforms: AI platforms currently assigned to the prompt (live).
  • est_answers_mo: Estimated monthly answer credits this prompt will consume given its current live country, persona, and platform assignments.
sort'text' | '-text' | 'created_at' | '-created_at' | 'prompt_volume' | '-prompt_volume' | 'mention_rate' | '-mention_rate' | 'citation_rate' | '-citation_rate'

Sort field. Prefix with - for descending.

Available sort fields:

  • text/-text: Sort alphabetically by prompt text
  • created_at/-created_at: Sort by creation date
  • prompt_volume/-prompt_volume: Sort by prompt volume level
  • mention_rate/-mention_rate: Sort by mention rate
  • citation_rate/-citation_rate: Sort by citation rate
pageinteger

Page number

per_pageinteger

Items per page

Response

Successful response