Skip to main content
Use API v1 to read the monitoring data available to your team, including answers, citations, competitors, and aggregate metrics.
API v1 requires an active Growth plan or above. Review your subscription if authentication reports an insufficient plan.

​
Base URL

All API endpoints are relative to:

​
Available endpoints

The API exposes these monitoring resources:

​
Quick start

1

Get your API token

Go to Team Management → API Access and create a new API token.
2

Make your first request

3

Explore your data

Use the brand ID to access performance metrics, competitors, sources, and more.

​
Response format

Responses are JSON. List endpoints generally return a resource array and a pagination object:
Most list endpoints include a pagination object with:
  • total: Total items matching the query
  • count: Items in this response
  • limit: Max items per page
  • offset: Items skipped
The /brands endpoint is the exception: it returns the full list with a top-level total count and no pagination object. See Entities for detailed data structures. Validation and resource errors include machine-readable codes:
Authentication and rate-limit errors use a flat shape. See Error codes before implementing error handling.

​
Get help