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>'
import requests

url = "https://api.scrunchai.com/v1/{brand_id}/responses"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.scrunchai.com/v1/{brand_id}/responses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrunchai.com/v1/{brand_id}/responses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.scrunchai.com/v1/{brand_id}/responses"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.scrunchai.com/v1/{brand_id}/responses")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrunchai.com/v1/{brand_id}/responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "total": 123,
  "items": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "prompt_id": 123,
      "prompt": "<string>",
      "persona_id": 123,
      "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": [],
      "query_fanout": {
        "queries": [
          "<string>"
        ],
        "engine_metadata": {}
      },
      "shopping_results": []
    }
  ],
  "offset": 0,
  "limit": 123,
  "metadata": {
    "period_count": 123,
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "top_domains": {
      "domains": [
        {
          "domain": "<string>",
          "domain_owner": "<string>",
          "observation_count": 123
        }
      ],
      "grand_total": 123,
      "owner_totals": {},
      "owner_time_series": [
        {
          "time_bucket": "<string>",
          "brand": 123,
          "competitor": 123,
          "other": 123
        }
      ],
      "segment_totals": [
        {
          "name": "<string>",
          "observation_count": 123
        }
      ]
    }
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

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
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 | 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