Scrunch API Docs bronze

api-agent-traffic-connect

api-ai-referrals

Use when a user wants to push pre-aggregated AI-sourced traffic data into Scrunch from any analytics tool, such as Adobe Analytics, a data warehouse or a log pipeline (not Google Analytics 4, which connects natively instead) — registering a push connection and sending daily pageview/session/transaction/revenue events, to power AI Referrals, the Explorer and Scrunchie. Triggers on "push our Adobe Analytics data to Scrunch", "send our analytics data to Scrunch", "send AI referral events via the API", "backfill historical AI traffic data", "register an AI referrals connection", or any request to feed non-GA4 analytics into Scrunch's AI traffic tracking. If the team uses Google Analytics 4, tell them to connect it through the in-app integration instead — this API is specifically for teams whose source of truth isn't GA4. Requires a Scrunch API key (SCRUNCH_API_TOKEN) — configure scope for registering connections and pushing events, query scope for listing them. A 404 on any endpoint here most likely means A

api-brand-setup

Use when a user wants to set up a new brand in Scrunch (AI-visibility monitoring) using the Scrunch REST API directly — via curl, a script, or any environment without the Scrunch MCP server connected (CI, a backend job, an agency onboarding tool) — creating the brand record with competitors and personas, reviewing/updating an existing one, or editing/removing an individual competitor or persona after creation. Generates a full brand profile (description, alternative names, personas, competitors, key topics) from just a domain. Triggers on "set up a Scrunch brand via the API", "create a brand with curl", "use the Configuration API to onboard [domain]", "script a brand creation", or any brand-creation request where MCP tools like create_brand/list_brands are not available. If the Scrunch MCP server IS connected, prefer scrunch-brand-setup instead — it additionally supports sub-brands, citation segments, and geo/industry fields that the REST API does not expose at all. Requires a Scrunch API key (SCRUNCH_A

api-dashboard-builder

Use when a user wants a visual AI-visibility dashboard for a Scrunch brand — non-branded presence, competitive benchmarking, presence by topic, citations (by owner, by domain, by URL), sentiment, and weakest-performing prompts — built by pulling the Scrunch REST API directly (Query, Signals APIs) rather than through the Scrunch MCP server. Renders as a Claude/coding-agent artifact or a self-contained HTML file. Triggers on "build a dashboard via the API", "generate a visibility dashboard with curl", "pull our Scrunch metrics into a dashboard", or any request for a visual AI-visibility summary in an environment without the Scrunch MCP server connected. Always runs a cheap data-sufficiency check before building anything substantial — a brand with no response data yet (e.g. right after api-get-started, inside the ~6-hour collection window) gets told that plainly instead of an elaborate dashboard built around empty results. Requires a Scrunch API key (SCRUNCH_API_TOKEN) with query scope.

api-get-started

Use when a user wants to get a brand fully started in Scrunch (AI-visibility monitoring) using the REST API in one pass — creating the brand, seeding an initial prompt library, and running immediate-value page audits, all via curl/scripts rather than the Scrunch MCP server. Triggers on "let's get started in Scrunch", "set me up in Scrunch", "onboard us via the API", "get our brand live in Scrunch using the API", or any end-to-end Scrunch setup request in a context where the Scrunch MCP server is not connected (CI, a backend job, an agency onboarding script). Orchestrates api-brand-setup, api-prompt-setup, and api-page-audit in sequence (parallelizing the latter two where the environment supports it) so the user gets something concrete to look at immediately instead of waiting on response collection. Requires a Scrunch API key (SCRUNCH_API_TOKEN) with configure scope. Before using this skill, check whether MCP tools like create_brand/create_prompt are available — if so, prefer the MCP-based flow (scrunch-b

api-page-audit

Use when a user wants to run (queue) and retrieve AI search readiness page audits for a Scrunch brand using the REST API directly — via curl, a script, a CI gate, or any environment without the Scrunch MCP server connected. Covers queuing one or many URLs for audit, polling for results, and reading the per-check breakdown (access controls, content delivery, content quality) plus the per-AI-platform crawler accessibility data. Triggers on "run a page audit via the API", "audit this URL with curl", "check AI search readiness for [url]", "queue a site audit", "poll for audit results", or any request to score a page's AI-crawler readiness where MCP tools aren't available. Requires a Scrunch API key (SCRUNCH_API_TOKEN) — configure scope to queue audits, query scope to read them.

api-prompt-setup

Use when a user wants to add, build, or audit the prompt library Scrunch tracks for a brand using the Scrunch REST API directly — via curl, a script, or any environment without the Scrunch MCP server connected. Writes the actual questions Scrunch asks AI platforms on a brand's behalf — funnel stage, tags, topics, personas, and which AI platforms to run against. Triggers on "add prompts via the API", "create prompts with curl", "script a prompt import", "build our prompt library via the Configuration API", or any prompt-creation request where MCP tools like create_prompt/list_prompt_stages are not available. If the Scrunch MCP server IS connected, prefer scrunch-prompt-setup instead — it additionally supports bulk tagging, topic management, stage reassignment after creation, and reading the brand's actual configured stage names, none of which the REST API exposes. Requires a Scrunch API key (SCRUNCH_API_TOKEN) with configure scope, and pairs with api-brand-setup, which should run first for a brand-new br

api-query-metrics

Use when a user wants custom or ad hoc AI-visibility metric queries from Scrunch via the REST API — beyond what api-dashboard-builder's fixed layout covers — including period-over-period comparisons, ranked breakdowns with an accurate grand total, threshold-filtered ("HAVING") pulls, tag/topic AND-matching, or Influence Score / market-pooled / cross-grain metrics. Covers both the simple GET query endpoint and the richer POST structured query endpoint. Triggers on "compare this week to last week via the API", "pull our top cited domains with an accurate total", "run a custom Scrunch query with curl", "what's our Influence Score for outreach", or any ad hoc BI-style metric pull in an environment without the Scrunch MCP server connected. For the standard fixed-layout visibility dashboard, use api-dashboard-builder instead — this skill is for one-off or custom reporting. Requires a Scrunch API key (SCRUNCH_API_TOKEN) — query scope for the GET endpoint, Query scope specifically for the POST structured endp

api-responses-export

Use when a user wants raw AI response data from Scrunch via the REST API — full response text, citations, competitor evaluations, and shopping results, for ETL pipelines, hallucination/misrepresentation audits, NLP or sentiment analysis, or building an internal review tool — rather than through the Scrunch MCP server. Triggers on "export raw responses via the API", "pull full AI answer text with curl", "audit what the AI actually said", "build an ETL job against Scrunch responses", or any request for response-level (not aggregated) data in an environment without the Scrunch MCP server connected. If the request is really for aggregated metrics (presence rate, position score, sentiment score) rather than the raw text, prefer api-dashboard-builder or ad hoc Query API calls instead — this skill is intentionally verbose and slower, built for depth over speed. Requires a Scrunch API key (SCRUNCH_API_TOKEN) with query scope.

api-signals-monitoring

Use when a user wants to feed Scrunch's detected AI-visibility changes (presence drops, position shifts, citation movements) into their own alerting, Slack digest, or incident tracker via the REST API — rather than through the Scrunch MCP server. Triggers on "pull our signals via the API", "what changed this week with curl", "build a custom Scrunch alert feed", "export signal reactions for reporting", or any "what changed" / automated-alerting request in an environment without the Scrunch MCP server connected. Read-only for API keys — reacting to a signal (marking it useful/actioned/dismissed) requires a user token (JWT), which this skill cannot obtain; say so if the user wants to react, not just read. Requires a Scrunch API key (SCRUNCH_API_TOKEN) with query scope, and works best on a brand at least a week old — a newer brand will legitimately have zero signals.

api-sitemap-export

Use when a user wants to inventory, filter, or export a Scrunch brand's crawled sitemap via the REST API — listing pages with audit scores and priority/optimized-content flags, pulling a single page's citation/AI-referral/agent-traffic trend, or exporting the whole sitemap to CSV/XLSX — rather than through the Scrunch MCP server. Triggers on "export our sitemap via the API", "list pages with curl", "pull a CSV of our crawled pages", "which pages are missing optimized content", "show me our priority pages", or any content-inventory request in an environment without the Scrunch MCP server connected. Requires a Scrunch API key (SCRUNCH_API_TOKEN) with query scope, and a brand that already has at least one completed crawl.

scrunch-brand-setup

Use when a user wants to set up a brand-new brand in Scrunch (AI-visibility monitoring) end to end — creating the brand record, competitors, sub-brands and sub-competitors, and personas — or wants their existing brand reviewed against best practices. Generates a full brand profile (description, alternative names, personas, competitors, key topics) from just a domain — doesn't require the user to fill out a questionnaire. Triggers on "set up my brand in Scrunch", "set up a brand for [domain]", "get started with Scrunch", "configure my brand", "add competitors to Scrunch", "add product lines / sub-brands", or any request to configure a Scrunch brand via natural language. If the user is already using a comparable AI-visibility tool and wants to bring that setup over, use scrunch-migrate-setup instead — it hands off to this skill's creation step rather than duplicating it. Requires the Scrunch MCP server (OAuth sign-in, no API key). Pairs with scrunch-citation-segments (citation tiering) and scrunch-promp

scrunch-citation-segments

Use when a user wants to build or update the citation segments on a Scrunch brand — grouping the domains/URLs AI platforms cite into named tiers (e.g. "Socials," "Publications," "Marketplaces," "Reviews"). Proactively proposes a sensible default set of segments and domains from the brand's own vertical — a client-supplied URL list is a nice-to-have, not a prerequisite. Triggers on "set up citation segments", "segment our citations", "add these publications as Tier 1/2/3", "here's a URL list, group it for citations", or any request to organize a brand's citation sources into named groups. Requires the Scrunch MCP server (OAuth sign-in, no API key). Pairs with scrunch-brand-setup, which should run first if the brand itself doesn't exist yet.

scrunch-migrate-setup

Use ONLY when the user is already using a comparable AI-visibility/AEO/GEO monitoring tool and wants to bring that setup into Scrunch, or explicitly asks to migrate, import, or switch their existing configuration over. Do not trigger on a passing mention of a competing tool, a general "how do we compare to X" question, or curiosity about another product — those aren't migration requests. Triggers on "I'm switching from [tool]", "migrate our setup into Scrunch", "import my brand/prompts from [tool]", "we currently track this somewhere else, can we move it over", or when the conversation has already established the user runs a comparable tool today. Requires the Scrunch MCP server (OAuth sign-in, no API key). Hands off to scrunch-brand-setup, scrunch-citation-segments, and scrunch-prompt-setup for the actual writes rather than reimplementing them.

scrunch-prompt-setup

Use when a user wants to build, audit, or expand the prompt library Scrunch tracks for a brand — writing new prompts (including local/geo-specific ones), assigning funnel stages/tags/topics/personas, recommending which AI platforms to track, or diagnosing "how is my brand doing in AI search". Triggers on "set up prompts", "build my prompt library", "add prompts to Scrunch", "are we showing up in AI search", "check our awareness visibility", "audit our prompt coverage", "which AI platforms should we track", "prompts for [city/region]", or any request to create or organize the questions Scrunch asks AI platforms. Requires the Scrunch MCP server (OAuth sign-in, no API key). Pairs with scrunch-brand-setup, which should run first for a brand-new brand.

scrunch-visibility-dashboard

Use when a user wants a visual AI-visibility dashboard for a Scrunch brand — presence, citations, sentiment, competitor benchmarking, weakest-performing prompts, and agent traffic (when available) — rendered as a Claude/coding-agent artifact or a self-contained HTML file, not a Scrunch Explorer link. Triggers on "build a visibility dashboard", "make a citation dashboard", "create an AI presence report", "generate a QBR-style dashboard", "make an HTML dashboard for [brand]", or any request for a shareable visual summary of a brand's AI-visibility data. Requires the Scrunch MCP server (OAuth sign-in, no API key).

scrunch-visual-style

Apply by default to any visual or written deliverable built from Scrunch MCP data — a dashboard, chart, deck, report, one-pager, or exported summary — even when not explicitly asked for by name, so the output matches Scrunch's actual brand system instead of an improvised palette. Skip only if the user has specified their own visual style/brand for the deliverable, or explicitly says not to apply Scrunch styling. Also triggers explicitly on "make this on-brand", "use Scrunch styling", "match Scrunch's brand guidelines", "style this like Scrunch". Loaded automatically by scrunch-visibility-dashboard and any other skill that renders a visual artifact. Not for drafting Scrunch's own marketing copy (blog posts, social, email, press releases) — that's Scrunch's internal brand-voice guidelines, a different scope than this skill covers.