# Onym

> Onym measures how often AI assistants (ChatGPT, Google AI Overviews and AI Mode, Gemini, Perplexity and coding assistants) name a brand, with sample sizes and 95% ranges on every number. It has a REST API, signed webhooks, an MCP server and Looker Studio / Sheets datasets.

## Get started
- [Measure how AI recommends your brand](https://getonym.com/docs.md): What Onym measures, how the pieces fit together, and where to start.
- [Track your first brand](https://getonym.com/docs/quickstart.md): Grade a site, claim it into a workspace, pick competitors and prompts, and read the first numbers.
- [Your first API request](https://getonym.com/docs/api-quickstart.md): Create an API key, call GET /domains and GET /metrics, and understand the response.
- [MCP server](https://getonym.com/docs/mcp.md): Connect Onym's hosted MCP server to Claude Code, Cursor, Claude.ai, ChatGPT and other clients; tools reference.

## Concepts
- [How Onym works](https://getonym.com/docs/how-it-works.md): Workspaces, domains, prompts, runs, answers, mentions, citations and surfaces.
- [Prompts and topics](https://getonym.com/docs/prompts.md): Library, custom and suggested prompts; topics; branded vs unbranded; statuses and limits.
- [Engines and surfaces](https://getonym.com/docs/engines.md): The surfaces Onym measures, consumer apps vs APIs, chat vs coding lanes, and surface keys.
- [Runs and schedule](https://getonym.com/docs/runs.md): Run cadence per plan, credits, run statuses and time zones.
- [Visibility](https://getonym.com/docs/visibility.md): Definition, formula, worked example, filters and how visibility differs from share of voice.
- [Share of voice](https://getonym.com/docs/share-of-voice.md): How share of voice is counted, with an example, and when to use it instead of visibility.
- [Position and sentiment](https://getonym.com/docs/position-sentiment.md): How average position, first-place answers and sentiment are measured.
- [Citations and sources](https://getonym.com/docs/citations.md): Citation rate, source types, the gap view and how URLs are attributed.
- [Confidence and significance](https://getonym.com/docs/confidence.md): Sample sizes, 95% Wilson ranges, paired comparisons and the significant flag.
- [Changes](https://getonym.com/docs/changes.md): The change types Onym detects, how they're tested, and where they're delivered.
- [Opportunities](https://getonym.com/docs/opportunities.md): Owned and earned opportunities, priority, the lifecycle and how impact is measured.
- [Site health](https://getonym.com/docs/site-health.md): robots.txt rules for AI crawlers, llms.txt and structured data.
- [Why past numbers change](https://getonym.com/docs/past-numbers.md): Which changes recompute past metrics and which only apply going forward.

## Guides
- [Weekly report in Google Sheets](https://getonym.com/docs/guides/sheets-report.md): Build a live visibility report in Google Sheets from Onym's CSV datasets, with a weighted trend and chart.
- [Alert Slack on real changes](https://getonym.com/docs/guides/slack-alerts.md): A complete, deployable webhook handler that verifies Onym's signature and posts to Slack.
- [Find outreach targets](https://getonym.com/docs/guides/outreach.md): Use the gap view of sources to find third-party pages that shape answers you're missing from.
- [Benchmark competitors](https://getonym.com/docs/guides/competitors.md): Choose competitors, read the benchmark, compare surfaces and pull the numbers from the API.
- [Agencies and client reporting](https://getonym.com/docs/guides/agencies.md): Portfolio view, pitches, share links, client reports, white-label branding and client email digests.

## Integrations
- [Webhooks](https://getonym.com/docs/webhooks.md): Events, payloads, signature verification, retries, testing and debugging for Onym webhooks.
- [MCP server](https://getonym.com/docs/mcp.md): Connect Onym's hosted MCP server to Claude Code, Cursor, Claude.ai, ChatGPT and other clients; tools reference.
- [Looker Studio](https://getonym.com/docs/looker-studio.md): Two ways to connect Looker Studio, the field dictionary for every dataset, and report recipes.
- [Google Sheets and CSV](https://getonym.com/docs/google-sheets.md): IMPORTDATA with the CSV datasets, dashboard CSV exports and their columns.
- [Slack and email](https://getonym.com/docs/slack-email.md): The email digest, client recipients and Slack alerts.

## Account
- [Plans and limits](https://getonym.com/docs/plans.md): Plan comparison, credits, enforcement, upgrades, downgrades and billing.
- [Models we track](https://getonym.com/docs/models.md): Live list of surfaces, models, lanes and credit prices.
- [Team and roles](https://getonym.com/docs/team.md): Roles, invites, seats and signing in.
- [Security and data](https://getonym.com/docs/security.md): Authentication, API key and webhook secret handling, data stored, sub-processors and deletion.

## Reference
- [Glossary](https://getonym.com/docs/glossary.md): Definitions of Onym's terms, from answer to verdict.
- [Changelog](https://getonym.com/docs/changelog.md): Dated list of changes to Onym's API, webhooks, MCP server and measurement.

## API reference
- [API reference](https://getonym.com/docs/api.md): Base URL, authentication, conventions and the list of endpoints.
- [Authentication](https://getonym.com/docs/api/authentication.md): API keys, read and write scopes, OAuth tokens and keeping keys safe.
- [Errors](https://getonym.com/docs/api/errors.md): Status codes, the error object, error types and every error code.
- [Filters](https://getonym.com/docs/api/filters.md): range, surface, topic and branded, with defaults and examples.
- [Rates and changes](https://getonym.com/docs/api/rates.md): The rate object, the change object, significance and pairs.
- [Pagination and limits](https://getonym.com/docs/api/pagination.md): Offset pagination on answers, list caps, the 600 requests per minute limit and rate-limit headers.
- [Versioning](https://getonym.com/docs/api/versioning.md): The v1 path version, what counts as breaking, and how changes are announced.
- [OpenAPI spec](https://getonym.com/api/v1/openapi.json): every endpoint, parameter and schema