Skip to main content

​
Scrunch API Overview

Scrunch gives you programmatic access to the same data and configuration that powers the Scrunch dashboard.
Use these APIs to query AI visibility metrics, ingest raw AI responses, automate onboarding, update brand configuration, and build custom reporting pipelines.

​
What you can do with the Scrunch API

Query AI visibility

Pull metrics like brand presence, sentiment score, position, competitor presence, and source citations across platforms.

Ingest raw AI responses

Access every response Scrunch collects, including text, citations, persona info, platform, sentiment, and competitor details.

Automate brand management

Programmatically create brands, update configuration, manage prompts, and power internal tooling.

​
API surface

Scrunch exposes three major APIs:
  • A high-performance reporting API that returns aggregated Scrunch metrics across dimensions like date, persona, tags, competitors, and source URLs.
  • Best for: BI tools, Looker Studio, scheduled reports, lightweight ETL.
  • Programmatic endpoints for creating and managing brands, prompts, personas, competitors, and other configuration data at scale.
  • Best for: Agencies managing many clients, automated brand setup, large-scale prompt management.
  • A raw response feed that delivers full text, citations, and scoring for every AI response to support deep analysis, ETL pipelines, and custom interfaces.
  • Best for: Custom UIs, detailed dashboards, data science workflows, ETL, large-scale analysis.

​
Authentication

All endpoints require a Bearer token.
You can create tokens under Organization → Settings → API Keys in the Scrunch dashboard. 
export SCRUNCH_API_TOKEN="your-key"

curl -H "Authorization: Bearer $SCRUNCH_API_TOKEN" \
  https://api.scrunchai.com/v1/brands
Brand-scoped keys can only access specific brands. Organization-scoped keys can access and configure all brands.

​
Quickstarts

​
API References

The full set of endpoints is auto-generated from our OpenAPI specification.

Explore endpoints

Browse Query, Responses, and Configuration endpoints.