Skip to main content
GET
/
{brand_id}
/
responses
List Responses
curl --request GET \
  --url https://api.scrunchai.com/v1/{brand_id}/responses \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "items": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "prompt_id": 123,
      "prompt": "<string>",
      "persona_id": 123,
      "stage": "Advice",
      "branded": true,
      "platform": "<string>",
      "brand_present": true,
      "response_text": "<string>",
      "persona_name": "<string>",
      "country": "<string>",
      "tags": [],
      "key_topics": [],
      "brand_sentiment": "<string>",
      "brand_position": "<string>",
      "competitors_present": [],
      "citations": [],
      "competitors": []
    }
  ],
  "offset": 0,
  "limit": 123
}

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

Query Parameters

​
platform
enum<string> | null

Filter responses to this AI platform

Available options:
chatgpt,
claude,
google_ai_overviews,
perplexity,
meta,
google_ai_mode,
google_gemini,
copilot
​
prompt_id
integer | null

Filter responses to this prompt ID

​
persona_id
integer | null

Filter responses to this persona ID

​
stage
enum<string> | null

Filter responses to this stage

Available options:
Advice,
Awareness,
Evaluation,
Comparison,
Other
​
start_date
string | null

Only return Responses collected after this date (inclusive)

​
end_date
string | null

Only return Responses collected before this date (exclusive)

​
limit
integer
default:100

Maximum number of responses to return

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Offset for pagination

Required range: x >= 0

Response

Successful Response

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