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>'
{
  "items": [
    {
      "id": 78901,
      "created_at": "2025-01-15T14:20:00Z",
      "prompt_id": 123,
      "prompt": "What are the best project management tools?",
      "persona_id": 45,
      "persona_name": "Tech Manager",
      "country": "US",
      "stage": "Evaluation",
      "branded": false,
      "tags": [
        "software",
        "productivity"
      ],
      "key_topics": [
        "Project Management"
      ],
      "platform": "chatgpt",
      "brand_present": true,
      "brand_sentiment": "positive",
      "brand_position": "top",
      "competitors_present": [
        "Asana",
        "Monday.com"
      ],
      "response_text": "Here are some popular project management tools...",
      "citations": [
        {
          "url": "https://example.com/article",
          "domain": "example.com",
          "source_type": "brand",
          "title": "PM Tools Comparison",
          "snippet": "We compared the top tools..."
        }
      ],
      "competitors": [
        {
          "id": 67,
          "name": "Asana",
          "present": true,
          "position": "middle",
          "sentiment": "positive"
        }
      ]
    }
  ],
  "total": 1523,
  "offset": 0,
  "limit": 100
}

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
​
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
enum<string> | null

Filter responses by customer journey stage.

Available stages:

  • Advice - Seeking recommendations
  • Awareness - Exploring a topic
  • Evaluation - Assessing options
  • Comparison - Comparing alternatives
  • Other - Other prompt types
Available options:
Advice,
Awareness,
Evaluation,
Comparison,
Other
​
start_date
string<date> | null

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

Example:

"2025-01-01"

​
end_date
string<date> | null

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

Example:

"2025-01-31"

​
limit
integer
default:100

Maximum number of responses to return per page

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

Number of responses to skip for pagination

Required range: x >= 0

Response

Paginated list of AI responses with evaluations and citations

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