Skip to main content
The Query API gives you flexible access to the same aggregated metrics shown in the Scrunch dashboard.
It is designed for analytics workloads, BI tools, reporting pipelines, and large-scale automation.

​
When to use the Query API

Use this API when you need:
  • Weekly or monthly reporting
  • Brand presence, position, sentiment, and competitor metrics
  • Aggregation by date, persona, tag, platform, or prompt
  • Data for dashboards (Looker, PowerBI, Tableau)
  • Large batch pulls of metrics (up to 50k records per call)
If you need raw text, citations, or competitor sentiment at the message level, use the Responses API.

​
Example query

curl -X GET \
  "https://api.scrunchai.com/v1/1234/query?fields=date_week,brand_presence_percentage,brand_sentiment_score" \
  -H "Authorization: Bearer $SCRUNCH_API_TOKEN"

​
How aggregation works

Scrunch automatically aggregates metrics across the dimensions you specify in fields.

​
For example:

fields=tag,brand_presence_percentage Returns one row per tag with the average presence percentage.
Avoid combining extremely granular fields like source_url + competitor_id unless you truly need them, as this may produce very large result sets.

​
Best practices

  • Prefer date_week or date_month instead of daily reporting
  • Query separate datasets and join them later for BI pipelines
  • Use brand-scoped keys when integrating into client dashboards
  • Keep field sets small to avoid large intermediate result sets

Run your first query

Go to the Query API Quickstart →