Sign in

v1

latestOpenAPI 3.0.12026-07-2318588.1 KB
Answers

List Answers

Individual AI answers with their cited URLs and brand/competitor mentions.

post/public_api/brand_kits/{brand_kit_id}/answers/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 (ISO 8601) on aeo_analyses.created_at. Defaults to 30 days ago.

end_datestring

End date (ISO 8601) on aeo_analyses.created_at. Defaults to today.

prompt_idinteger

Filter answers by a single prompt (question) ID.

providersstring[]

Filter by AI providers.

countriesstring[]

Filter by ISO alpha-2 country codes.

brand_mentionedboolean

When set, filter to answers where the brand was (or was not) mentioned.

fieldsstring[]

Select additional fields to return.

Optional fields:

  • id: Answer ID
  • date: Analysis date (YYYY-MM-DD)
  • text: Answer text. Truncated to 200 chars with ellipsis on list; full on show.
  • prompt: Prompt (question) text
  • citations: URLs cited by the answer (deduped)
  • mentions: Brand names mentioned in the answer (self brand + competitors)
  • persona: Persona name or "default"
  • provider: AI provider
  • country: ISO alpha-2 country code
  • web_search_triggered: Whether the AI performed a web search for this answer
  • brand_mentioned: Whether the brand was mentioned in this answer
pageinteger

Page number

per_pageinteger

Items per page

Response

Successful response