Skip to main content
GET
List Responses

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

The unique identifier for the brand

Query Parameters

platform
enum<string> | null

Filter responses by AI platform.

Supported platforms:

  • chatgpt - OpenAI ChatGPT
  • claude - Anthropic Claude
  • google_ai_overviews - Google AI Overviews (Search)
  • perplexity - Perplexity AI
  • meta - Meta AI
  • google_ai_mode - Google AI Mode
  • google_gemini - Google Gemini
  • copilot - Microsoft Copilot
Available options:
chatgpt,
claude,
google_ai_overviews,
perplexity,
meta,
google_ai_mode,
google_gemini,
copilot,
grok
prompt_id
integer | null

Filter responses to a specific prompt by its ID

persona_id
integer | null

Filter responses to a specific persona by its ID

stage
string | null

Filter responses by customer journey stage. Values are resolved from your brand's configured stages, so they vary per brand.

Default stage sets:

  • Intent (v1)Advice, Awareness, Evaluation, Comparison, Other
  • Funnel (v2)Awareness, Consideration, Conversion, Loyalty, Other

Brands that rename or add stages accept those custom names too.

start_date
string | null

Only return responses collected on or after this date (inclusive). Format: YYYY-MM-DD

end_date
string | null

Only return responses collected before this date (exclusive). Format: YYYY-MM-DD

has_shopping_data
boolean | null

Filter responses by shopping data presence. True returns only responses with shopping results, False returns only responses without.

limit
integer
default:100

Maximum number of responses to return per page

Required range: x >= 1
offset
integer
default:0

Number of responses to skip for pagination

Required range: x >= 0

Response

Successful Response

total
integer
required
items
ResponseListing · object[]
required
offset
integer
default:0
limit
integer | null
metadata
TimeSeriesMetadata · object | null