# Scrunch API Docs

## Docs

- [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.
- [Agent Traffic API Overview](https://developers.scrunch.com/api-reference/agent-traffic/overview.md): Track and analyze AI bot visits to your websites.
- [Agent Traffic](https://developers.scrunch.com/api-reference/agent-traffic/post-custom-web-traffic.md): Send agent traffic data from any platform to Scrunch AI.
- [Archive Competitor](https://developers.scrunch.com/api-reference/archive-competitor.md): Archive a competitor
- [Archive Persona](https://developers.scrunch.com/api-reference/archive-persona.md): Archive a persona
- [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.
- [Configuration API Overview](https://developers.scrunch.com/api-reference/configuration/overview.md): Create brands, update configuration, and manage prompts programmatically.
- [Create Brand](https://developers.scrunch.com/api-reference/create-brand.md): Create a new brand
- [Create Competitor](https://developers.scrunch.com/api-reference/create-competitor.md): Create a new competitor
- [Create Page Audits](https://developers.scrunch.com/api-reference/create-page-audits.md): Create one or more page audits
- [Create Persona](https://developers.scrunch.com/api-reference/create-persona.md): Create a new persona
- [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.
- [Get Competitor](https://developers.scrunch.com/api-reference/get-competitor.md): Get a competitor by ID
- [Get Persona](https://developers.scrunch.com/api-reference/get-persona.md): Get a persona by ID
- [Introduction](https://developers.scrunch.com/api-reference/introduction.md): APIs for querying AI visibility, analyzing responses, and managing brands in Scrunch.
- [List Brands](https://developers.scrunch.com/api-reference/list-brands.md): List available brands
- [List Competitors](https://developers.scrunch.com/api-reference/list-competitors.md): List competitors for a brand
- [List Personas](https://developers.scrunch.com/api-reference/list-personas.md): List personas for a brand
- [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.
- [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.
- [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.
- [Query API Overview](https://developers.scrunch.com/api-reference/query/overview.md): Retrieve aggregated brand presence, position, sentiment, and competitor metrics.
- [Responses API Overview](https://developers.scrunch.com/api-reference/responses/overview.md): Retrieve full AI responses, citations, and brand and competitor evaluation data.
- [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.
- [Update Competitor](https://developers.scrunch.com/api-reference/update-competitor.md): Update a competitor
- [Update Persona](https://developers.scrunch.com/api-reference/update-persona.md): Update a persona
- [Provision an API Key](https://developers.scrunch.com/getting-started/authentication.md)
- [Query API Quickstart](https://developers.scrunch.com/getting-started/quickstart-query.md): Make your first API call to Scrunch and retrieve weekly brand visibility data.
- [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.
- [Send Agent Traffic via API](https://developers.scrunch.com/guides/agent-traffic-api-integration.md): Use the custom API platform to send AI bot traffic data to Scrunch from any hosting environment.
- [Load a Data Mart from the Responses API](https://developers.scrunch.com/guides/data-mart-loading.md): Use the Scrunch Responses API to build and maintain a structured data mart in your warehouse.
- [Introduction](https://developers.scrunch.com/index.md): Use the Scrunch API to get programmatic access to AI search visibility data.
- [Connecting to Scrunch Agent Traffic](https://developers.scrunch.com/integrations/agent-traffic.md): Track AI bots visiting your site.
- [Data Studio](https://developers.scrunch.com/integrations/data-studio.md): Multi-brand Data Studio [formerly Looker Studio] connector with AI visibility metrics and agent traffic data.
- [Looker Studio (legacy)](https://developers.scrunch.com/integrations/looker-studio.md): Legacy single-brand Looker Studio connector. For new setups, use the v2 connector.

## OpenAPI Specs

- [openapi](https://developers.scrunch.com/api-reference/openapi.json)

## Optional

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