# Scrunch API Docs

- [Build with Scrunch](https://developers.scrunch.com/index.md): Use Scrunch APIs, the MCP, or Data Studio integrations to query AI visibility data, automate configuration, and power custom reports.
- [Provision an API key](https://developers.scrunch.com/getting-started/authentication.md): Create, scope, and rotate Scrunch API keys at the organization level to authenticate Query, Responses, Configuration, and Agent Traffic requests.
- [Query API Quickstart](https://developers.scrunch.com/getting-started/quickstart-query.md): Step-by-step walkthrough for your first Scrunch Query API call to fetch weekly brand presence, sentiment, and AI visibility metrics by platform.
- [Responses API Quickstart](https://developers.scrunch.com/getting-started/quickstart-responses.md): Use the Responses API to retrieve full AI answers, citations, sentiment, competitors, and metadata for every Scrunch prompt execution.
- [Optimize and Deploy Quickstart](https://developers.scrunch.com/getting-started/quickstart-orchestration.md): Step-by-step guide to submitting pages for AI search audit, content optimization, and AXP deployment using a single Scrunch pipeline API call.
- [Load a Data Mart from the Responses API](https://developers.scrunch.com/guides/data-mart-loading.md): Incrementally load response-level data from the Scrunch Responses API, normalize it into fact and dimension tables, and compute metrics in your warehouse.
- [Send Agent Traffic via API](https://developers.scrunch.com/guides/agent-traffic-api-integration.md): Forward AI bot traffic logs to Scrunch from any CDN, edge worker, or hosting environment using the custom Agent Traffic ingestion endpoint and JSON or NDJSON.
- [Optimize and Deploy Pipeline Lifecycle Guide](https://developers.scrunch.com/guides/orchestration-lifecycle.md): Walk through every stage of the Optimize and Deploy pipeline — submitting URLs, tracking progress, polling status, handling errors, and processing results.
- [Install the Scrunch Data Studio Connector (v2)](https://developers.scrunch.com/integrations/data-studio-connector.md): Install and configure the Scrunch Data Studio v2 connector to compare up to 30 brands side by side in Looker Studio and pull in agent traffic data.
- [Data Studio Dashboard Templates for Scrunch](https://developers.scrunch.com/integrations/data-studio-templates.md): Copy pre-built Looker Studio dashboards for multi-brand visibility, single-brand performance, and AI agent traffic and connect them to your Scrunch data.
- [Troubleshoot the Scrunch Data Studio Connector](https://developers.scrunch.com/integrations/data-studio-troubleshooting.md): FAQs, error fixes, and reset instructions for the Scrunch Data Studio connector covering brand IDs, agent traffic charts, date grouping, and auth issues.
- [Looker Studio Legacy Single-Brand Connector](https://developers.scrunch.com/integrations/looker-studio.md): Configure the legacy single-brand Scrunch Looker Studio Community Connector to build dashboards and blend brand visibility metrics with GA4 and other sources.
- [Connect Your CDN to Scrunch Agent Traffic](https://developers.scrunch.com/integrations/agent-traffic.md): Stream AI crawler and bot access logs from supported CDNs and hosting platforms into Scrunch Agent Traffic to track which pages AI bots visit and why.
- [Scrunch API Introduction and Authentication](https://developers.scrunch.com/api-reference/introduction.md): Programmatic access to AI visibility metrics, raw AI responses, brand configuration, and reporting pipelines through the Scrunch REST APIs.
- [Query API: Aggregated AI Visibility Metrics](https://developers.scrunch.com/api-reference/query/overview.md): Pull aggregated brand presence, position, sentiment, citation, and competitor metrics across AI platforms and date ranges from Scrunch.
- [Query](https://developers.scrunch.com/api-reference/query.md): Query the data API to retrieve aggregated observation data across multiple dimensions and metrics. This endpoint dynamically generates SQL queries based on the requested fields, allowing flexible aggregation for analytics and reporting workflows.
- [Structured Query API: Multi-Metric JSON Endpoint](https://developers.scrunch.com/api-reference/query/structured-query.md): POST brand-scoped JSON queries with dimensions, metrics, HAVING thresholds, negated filters, and prior-period or prior-year comparisons.
- [Responses API: Raw AI Answers and Citations](https://developers.scrunch.com/api-reference/responses/overview.md): Retrieve every raw AI response Scrunch collects with full text, citations, sentiment, competitor evaluations, persona, and platform metadata.
- [List Responses](https://developers.scrunch.com/api-reference/list-responses.md): Returns AI responses (observations) with full evaluation data, citations, and competitor analysis. Each response represents a single AI-generated answer to a tracked prompt.
- [Agent Traffic API: Monitor AI Bot Crawls](https://developers.scrunch.com/api-reference/agent-traffic/overview.md): Aggregate AI bot and crawler traffic across your sites by date, path, agent source, and bot type to monitor retrieval, training, and indexing activity.
- [Get Agent Traffic](https://developers.scrunch.com/api-reference/agent-traffic/get-agent-traffic.md): Retrieve aggregated bot and AI agent traffic data for a specific site.
- [Send Custom Agent Traffic Events](https://developers.scrunch.com/api-reference/agent-traffic/post-custom-web-traffic.md): POST AI bot and agent traffic events from any web host, CDN, or edge function to Scrunch using the custom web-traffic ingestion endpoint.
- [AI Referrals API: Push AI-Sourced Traffic Data](https://developers.scrunch.com/api-reference/ai-referrals/overview.md): Push pre-aggregated daily referral events from Adobe Analytics and other tools into Scrunch to power the AI Traffic dashboard and Site Map metrics.
- [Register AI Referrals Connection](https://developers.scrunch.com/api-reference/ai-referrals/register-ai-referrals-connection.md): Register an AI Referrals push connection for a (brand, website, provider) tuple. Events can only be pushed once a connection exists.
- [List AI Referrals Connections](https://developers.scrunch.com/api-reference/ai-referrals/list-ai-referrals-connections.md): List AI Referrals push connections registered for this brand. Scope is limited to push connections only — Google Analytics integrations live in a separate system and are not returned here, even though they can block a register call with `409`.
- [Disable AI Referrals Connection](https://developers.scrunch.com/api-reference/ai-referrals/disable-ai-referrals-connection.md): Soft-disable a connection. Previously pushed events are retained but further pushes are rejected with `410 Gone` and the dashboard stops reading from this connection.
- [Push AI Referrals Events](https://developers.scrunch.com/api-reference/ai-referrals/push-ai-referrals-events.md): Push a batch of pre-aggregated daily AI-referral events for a registered connection.
- [Site Audit API: Score pages for AI search readiness](https://developers.scrunch.com/api-reference/site-audit/overview.md): Queue page audits for URLs on your brand's domain and fetch the AI search readiness checks, scores, and previews that power the Site Audit stage.
- [Create Page Audits](https://developers.scrunch.com/api-reference/create-page-audits.md): Create one or more page audits
- [List Page Audits](https://developers.scrunch.com/api-reference/list-page-audits.md): List page audits in reverse chronological order
- [Get Page Audit](https://developers.scrunch.com/api-reference/get-page-audit.md): Get a specific page audit by ID
- [Signals API: Detected changes in AI visibility](https://developers.scrunch.com/api-reference/signals/overview.md): Query Scrunch's nightly detection sweep for statistically-tested level changes and trends in AI visibility metrics, with stable signal identity.
- [Sitemap API: Pages, Audit Scores, AI Metrics](https://developers.scrunch.com/api-reference/sitemap/overview.md): List, inspect, and export pages from your brand's sitemap with audit scores, citations, AI referrals, and bot traffic metrics for each URL.
- [List Sitemap Pages](https://developers.scrunch.com/api-reference/sitemap/list-sitemap-pages.md): List pages discovered in the brand's sitemap with their title, description, depth, audit score, priority flag, and optimized-content flag.
- [Get Sitemap Page](https://developers.scrunch.com/api-reference/sitemap/get-sitemap-page.md): Get detailed information about a single page in the brand's sitemap, including title, description, depth, audit score, canonical URL, last-indexed timestamp, priority flag, and optimized-content flag.
- [Get Sitemap Page Metrics](https://developers.scrunch.com/api-reference/sitemap/get-sitemap-page-metrics.md): Return time-series performance metrics for a single page: citations, AI referrals, and AI agent traffic. Each metric is reported as a list of buckets keyed by date, with counts broken down by AI platform.
- [Export Sitemap Pages](https://developers.scrunch.com/api-reference/sitemap/export-sitemap-pages.md): Download every page matching the supplied filters as CSV or XLSX. Uses the same filters as the list endpoint but skips pagination.
- [Create Collection Request](https://developers.scrunch.com/api-reference/create-collection-request.md): Triggers on-demand collection for a prompt across the specified AI platforms. Each platform will be queried and the response evaluated independently.
- [AXP Render API: Queue Optimized Page Renders](https://developers.scrunch.com/api-reference/axp/overview.md): Queue asynchronous render jobs that fetch, sanitize, and persist pages on your AXP site so optimized content is ready to deploy from one API call.
- [Bulk Render Optimized Pages](https://developers.scrunch.com/api-reference/axp-render/bulk-render-optimized-pages.md): Queue render jobs for a list of paths on a registered AXP site. Each path is fetched, sanitized, and persisted as an AXP optimized page asynchronously, so the endpoint returns immediately with one job entry per input path.
- [AXP Unpublish API: Take Optimized Pages Off the Edge](https://developers.scrunch.com/api-reference/axp/unpublish.md): Remove curated AXP pages from the edge on demand and retire their rows so no automated re-stage, redeploy, or rollback republishes them.
- [Unpublish Optimized Pages](https://developers.scrunch.com/api-reference/axp-render/unpublish-optimized-pages.md): Stop serving optimized content for a list of paths on a registered AXP site. Each path is removed from the edge and its row is terminally retired, so no automated writer (re-stage, redeploy, rollback, or render job) republishes it. The endpoint is idempotent and returns one outcome per requested pat…
- [Optimize and Deploy Pipeline API Overview](https://developers.scrunch.com/api-reference/orchestration/overview.md): Run a single async pipeline to audit pages, optimize content for AI search visibility, and deploy results to AXP with polling or webhooks.
- [Create Optimize And Deploy Pipeline](https://developers.scrunch.com/api-reference/orchestration/create-optimize-and-deploy-pipeline.md): Create an orchestrated pipeline: audit pages, optimize content, and deploy to AXP
- [Get Pipeline Status](https://developers.scrunch.com/api-reference/orchestration/get-pipeline-status.md): Get the status of an optimize-and-deploy pipeline by token
- [Webhooks: Pipeline Stage Completion Callbacks](https://developers.scrunch.com/api-reference/webhooks/overview.md): Subscribe to real-time webhook callbacks for Optimize and Deploy pipeline events including audit, optimization, and AXP deployment completion.
- [Configuration API: Manage Brands and Prompts](https://developers.scrunch.com/api-reference/configuration/overview.md): Create brands, manage competitors and personas, and configure tracking prompts via the Scrunch Configuration API to automate client onboarding.
- [List Brands](https://developers.scrunch.com/api-reference/list-brands.md): List available brands
- [Create Brand](https://developers.scrunch.com/api-reference/create-brand.md): Create a new brand
- [Update Brand](https://developers.scrunch.com/api-reference/update-brand.md): Partially update a brand. Only fields included in the request body are modified. For competitors and personas, the provided list represents the full desired state: include an `id` to update an existing record, omit `id` to create a new one, and any existing records not in the list are archived.
- [List Competitors](https://developers.scrunch.com/api-reference/list-competitors.md): List competitors for a brand
- [Get Competitor](https://developers.scrunch.com/api-reference/get-competitor.md): Get a competitor by ID
- [Create Competitor](https://developers.scrunch.com/api-reference/create-competitor.md): Create a new competitor
- [Update Competitor](https://developers.scrunch.com/api-reference/update-competitor.md): Update a competitor
- [Archive Competitor](https://developers.scrunch.com/api-reference/archive-competitor.md): Archive a competitor
- [List Personas](https://developers.scrunch.com/api-reference/list-personas.md): List personas for a brand
- [Get Persona](https://developers.scrunch.com/api-reference/get-persona.md): Get a persona by ID
- [Create Persona](https://developers.scrunch.com/api-reference/create-persona.md): Create a new persona
- [Update Persona](https://developers.scrunch.com/api-reference/update-persona.md): Update a persona
- [Archive Persona](https://developers.scrunch.com/api-reference/archive-persona.md): Archive a persona
- [List Prompts](https://developers.scrunch.com/api-reference/list-prompts.md): Returns a paginated list of active prompts for the specified brand, including their variants, tags, and topics. Use this endpoint to retrieve all prompts configured for AI visibility tracking.
- [Create Prompt](https://developers.scrunch.com/api-reference/create-prompt.md): Creates a new prompt with variants for the specified platforms. Requires the `configure` scope.
- [Archive Prompt](https://developers.scrunch.com/api-reference/archive-prompt.md): Archives a prompt (soft delete). The prompt will no longer be tracked but historical data is preserved. Requires the `configure` scope.
- [Meet Scrunchie](https://developers.scrunch.com/mcp/overview.md): Connect your Scrunch data to Claude, ChatGPT, and other AI assistants. Ask questions in plain English and get answers from your live data.
- [Connect Claude, ChatGPT, or Cursor to Scrunch MCP](https://developers.scrunch.com/mcp/setup.md): Step-by-step setup to connect the Scrunch MCP server to Claude, ChatGPT, Perplexity, Cursor, VS Code, or Microsoft Copilot Studio using OAuth in 5 minutes.
- [Scrunch MCP Feature Reference and Example Prompts](https://developers.scrunch.com/mcp/tools.md): Reference for 45 Scrunch MCP tools covering reporting, signals, responses, prompts, brand configuration, agent traffic, and help docs, with example prompts.
- [Scrunch Agent Skills](https://developers.scrunch.com/mcp/skills/overview.md): Install Scrunch's Agent Skills so Claude Code, Codex, and other skill-aware agents can set up brands, prompt libraries, citation segments, and dashboards.
- [Switch from Another AI Visibility Tool in One Conversation](https://developers.scrunch.com/mcp/workflows/switch-from-another-tool.md): MCP workflow to migrate brands, personas, tags, competitors, and your full prompt library from another AI visibility tool into Scrunch in one chat.
- [New Brand Live in One Conversation](https://developers.scrunch.com/mcp/workflows/new-brand-live.md): MCP workflow that onboards a brand end to end: creates the brand, adds competitors, and seeds a tagged prompt library from one chat with your AI agent.
- [Bulk Prompt Import from a Spreadsheet](https://developers.scrunch.com/mcp/workflows/bulk-prompt-import-from-sheets.md): Read a spreadsheet of seed queries, tags, and personas you already have and bulk-create them as tracked Scrunch prompts in one conversation.
- [Weekly AI Brief, Saved to Notion or Google Docs](https://developers.scrunch.com/mcp/workflows/weekly-ai-brief.md): One prompt pulls this week's visibility data, saves a full brief to Notion or Google Docs, and posts the headline numbers to Slack.
- [Monthly Client Report, Built Automatically](https://developers.scrunch.com/mcp/workflows/monthly-client-report.md): Pull a month's worth of visibility data and have Claude write, structure, and save a complete report to Notion — ready to share or drop into a deck.
- [Auto-Build a QBR Deck](https://developers.scrunch.com/mcp/workflows/qbr-deck-builder.md): Turn a brand's presence, position, sentiment, and citation metrics into a formatted quarterly business review deck in Google Slides or PowerPoint.
- [Draft a Stakeholder Email Update](https://developers.scrunch.com/mcp/workflows/stakeholder-email-update.md): Pull this period's AI visibility headlines from Scrunch and have Claude draft a stakeholder email update, staged for your review before sending.
- [Executive Explorer Dashboard](https://developers.scrunch.com/mcp/workflows/executive-explorer-dashboard.md): Assemble a saved Scrunch Explorer dashboard covering presence, position, sentiment, and citations in one conversation, and get a shareable link back.
- [Competitor Share of Voice, Ranked](https://developers.scrunch.com/mcp/workflows/competitor-share-of-voice.md): Rank every tracked competitor by how often they appear in AI responses, find where they're displacing you, and surface the specific prompts to reclaim.
- [Live Competitor Tracker Spreadsheet](https://developers.scrunch.com/mcp/workflows/competitor-tracker-spreadsheet.md): Build a spreadsheet of share-of-voice by competitor that you re-run on a cadence to append each period's snapshot into a running trend tab.
- [Competitive Battlecard Generator](https://developers.scrunch.com/mcp/workflows/competitive-battlecard.md): Build a per-competitor AI visibility battlecard covering wins, gaps, and talking points, saved to Notion or Google Docs for sales enablement.
- [Find Visibility Gaps Worth Fixing](https://developers.scrunch.com/mcp/workflows/find-visibility-gaps.md): MCP workflow to surface your weakest AI visibility topics, identify the specific prompts you're losing, and ship a prioritized content action plan to Notion.
- [Where Search Rankings and AI Presence Diverge](https://developers.scrunch.com/mcp/workflows/search-vs-ai-gaps.md): MCP workflow that joins Google Search Console queries with Scrunch data to find pages ranking in search but missing from AI responses, your top-ROI fixes.
- [Build an AI Content Brief from Keyword Rankings](https://developers.scrunch.com/mcp/workflows/keyword-rankings-to-ai-brief.md): Combine Semrush or Ahrefs keyword rankings with Scrunch citation gaps to prioritize which content to create or fix and what it must say to get cited.
- [Build Your Prompt Library from SEO Keywords](https://developers.scrunch.com/mcp/workflows/prompts-from-keywords.md): Compare your SEO keyword list against existing Scrunch prompts, cluster the gaps, and create new tracking prompts in one conversation.
- [Create Content That Gets AI Citations](https://developers.scrunch.com/mcp/workflows/create-content-for-citations.md): Use Scrunch citation gaps to identify what to write, generate content optimized for AI retrieval, and publish it through your CMS — all in one workflow.
- [Content Brief Handoff to Design](https://developers.scrunch.com/mcp/workflows/content-brief-to-design.md): Turn a Scrunch visibility gap into a structured content brief and hand it to your design or content team as a FigJam board, ready to move into layout.
- [GSC Query-Gap Prompt Expansion](https://developers.scrunch.com/mcp/workflows/gsc-query-gap-expansion.md): Find Google Search Console queries you already rank for that aren't tracked as Scrunch prompts yet, and bulk-create prompts for the top gaps.
- [Measure AI Visibility's Impact on Traffic](https://developers.scrunch.com/mcp/workflows/ai-visibility-traffic-impact.md): Pair Google Analytics with Scrunch after lifting AI presence on a topic to confirm whether traffic followed and build the ROI case for AI visibility work.
- [Stage Content Tasks for Review](https://developers.scrunch.com/mcp/workflows/content-task-handoff.md): MCP workflow that turns a Scrunch content gap into a fully-briefed Linear, Jira, GitHub, or Asana ticket for the teammate who owns publishing.
- [Agent Traffic to a Spreadsheet Dashboard](https://developers.scrunch.com/mcp/workflows/agent-traffic-to-spreadsheet.md): Export Scrunch's AI bot crawl data as CSV and turn it into a pivoted, chartable spreadsheet showing GPTBot, ClaudeBot, and PerplexityBot activity over time.
- [Citation Wins Tied to Pipeline](https://developers.scrunch.com/mcp/workflows/citation-wins-to-pipeline.md): Match newly-won AI citations and prompt visibility against your CRM's open deals to show which AI visibility gains are touching active revenue.
- [Weekly Visibility Alert to Slack](https://developers.scrunch.com/mcp/workflows/weekly-visibility-alert-slack.md): Compare this week's presence, position, sentiment, and citation metrics to last week, and post a flagged alert to Slack when a threshold is crossed.
- [Which Cited Pages Actually Convert](https://developers.scrunch.com/mcp/workflows/landing-page-citation-impact.md): Cross-reference the specific pages AI engines are citing against Google Analytics conversion data to see which citations are driving more than just traffic.
- [Configuration & Maintenance](https://developers.scrunch.com/mcp/prompts/configuration.md): Audit your Scrunch setup, find duplicate prompts, check platform coverage, standardize tags, and clean up stale configuration with conversational MCP prompts.
- [Brand Presence & Visibility](https://developers.scrunch.com/mcp/prompts/visibility-overview.md): Starter MCP prompts that calculate your AI visibility score and establish where your brand stands across tracked prompts, platforms, and reporting cycles.
- [Platform-Specific Analysis](https://developers.scrunch.com/mcp/prompts/platform-analysis.md): MCP prompts that compare brand visibility on ChatGPT, Perplexity, Gemini, and Google AI Overviews to find which platform is underperforming and why.
- [Rankings & Priority Lists](https://developers.scrunch.com/mcp/prompts/rankings.md): MCP prompts that return ranked top-10 and bottom-10 lists of best performing prompts, biggest missed opportunities, and weakest topic areas for triage.
- [Sentiment Signals](https://developers.scrunch.com/mcp/prompts/sentiment-signals.md): MCP prompts that go beyond the presence question to check how AI assistants actually talk about your brand — positive, mixed, or negative — and why.
- [Visibility Gaps & Content Opportunities](https://developers.scrunch.com/mcp/prompts/visibility-gaps.md): MCP prompts that find topics where your brand is absent from AI responses, rank gaps by urgency, and group them into actionable content opportunities.
- [White Space & Growth Opportunities](https://developers.scrunch.com/mcp/prompts/white-space.md): MCP prompts that surface uncontested AI search territory — queries where neither you nor competitors appear yet, ranked by first-mover value.
- [Citation Analysis](https://developers.scrunch.com/mcp/prompts/citation-analysis.md): Find which pages AI is citing from your site, which topic areas get skipped, and which third-party sources are driving your mentions.
- [Trends & Alerts](https://developers.scrunch.com/mcp/prompts/trends-and-alerts.md): MCP prompts that frame metrics over time — what changed since last period, what's been quietly sliding, and what's crossed a threshold worth flagging.
- [Competitive Intelligence](https://developers.scrunch.com/mcp/prompts/competitive-intel.md): MCP prompts to rank competitors by AI share of voice, identify where rivals are displacing your brand, and surface positions you need to protect in AI search.
- [Reporting Digests](https://developers.scrunch.com/mcp/prompts/reporting.md): MCP prompts that generate structured monthly digests, QBR slides, client call prep docs, and onboarding briefs ready to drop into a presentation.
- [Visualize It](https://developers.scrunch.com/mcp/prompts/visualize-it.md): MCP prompts that turn a metric question directly into a Scrunch Explorer chart or saved dashboard, using generate_explorer_chart and create_explorer_dashboard.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [Status](https://status.scrunchai.com)
- [Blog](https://scrunch.com/blog)