Base URL
Your first call
1
Create an API key
In the dashboard, open Settings > API keys and click Create key. Copy it right away: it starts with
hk_ and is shown only once. See Authentication.2
Find your website ID
Most endpoints work on one website. List the workspaces and websites your key can reach:Note the
id of the website you want.3
Read your data
Pass the ID as
website_id. This call lists the last month of ChatGPT and Perplexity citations:What you can do
Account
Who the key belongs to, its workspaces and websites.
AI visibility
Citations, prompts, topics, search queries and URL lookup.
Competition and sources
Share of voice, competitor suggestions and the sources AI cites.
Site
Audits, health, indexation, content gaps and AI-crawler traffic.
Outreach
Sources to win, pitches to approve, follow-ups and agent permissions.
Conventions
Website-scoped endpoints
Website-scoped endpoints
Data endpoints take a required
website_id query parameter. The key must belong to a member of the website’s workspace, and the website needs an active subscription, otherwise the API answers 403. Discovery endpoints (/me, /workspaces, /websites) need no website_id.Reads and writes
Reads and writes
GET requests only need workspace membership. POST, PUT, PATCH and DELETE also need a role that can edit. A key owned by a read-only member gets 403 on every write.Quotas
Quotas
Actions that spend plan resources (prompts, competitors, audits, health refreshes, content gaps) have a matching
quota endpoint. Check it before you act. Your plan sets the limits.Dates and times
Dates and times
Timestamps are ISO 8601 in UTC. Date filters (
date_from, date_to) take YYYY-MM-DD and win over time_range when both are set.REST API or MCP?
Both use the same key, the same rate limit and the same permissions.- REST API: your own code, scheduled jobs, BI dashboards, warehouse syncs.
- MCP server: AI assistants such as Claude or ChatGPT exploring your data in a conversation. See the MCP setup guide.
Download the OpenAPI spec
Generate a typed client, or import every endpoint into Postman, Insomnia or Bruno.