API Keys & Scopes
Create, manage, and scope personal API keys. Full scope reference.
Last updated August 31, 2026
Personal API keys let you authenticate REST API calls from scripts, automation tools, and third-party integrations.
Creating a key
- Go to Settings → API.
- Click Create new key.
- Enter a name (e.g. “Zapier integration”, “Looker Studio”).
- Optionally set:
- Expiry - auto-expire after 1-365 days
- Scopes - restrict the key to specific capabilities
- Brand restriction - limit the key to specific brands
- Click Create.
- Copy the full key immediately - it’s shown only once.
You can have up to 10 active keys per account.
Full scope reference
Omitting scopes gives the key full product access. To limit blast radius, specify only the scopes your integration needs:
Usage
| Scope |
What it covers |
read:usage |
AI-query credit balance and usage totals (/api/usage, /api/me/api-credits) |
Tracked prompts
| Scope |
What it covers |
read:prompts |
View tracked prompts, results, and AI answer data (/api/ai-seo, /api/answers) |
write:prompts |
Add, edit, or delete tracked prompts |
Research
| Scope |
What it covers |
read:research |
View saved AI-search results, keyword research history, agent outputs (/api/ai-search, /api/aeo, /api/keyword-research, /api/agents, /api/sources) |
write:research |
Trigger new research runs, keyword harvests, agent invocations |
Reports & analytics
| Scope |
What it covers |
read:reports |
Read analytics, rank tracking, backlinks (/api/reports, /api/analytics, /api/rank-tracking, /api/backlinks) |
BI / metrics (versioned API)
| Scope |
What it covers |
read:metrics |
Read the versioned metrics API (/api/v1/metrics) - used by the Looker Studio connector |
Data exports
| Scope |
What it covers |
read:exports |
Pull structured CSV/JSON export of a brand’s report data (/api/v1/exports) |
Brands & products
| Scope |
What it covers |
read:brands |
View brands and products (/api/brands, /api/products) |
write:brands |
Create or modify brands and products |
Content & publishing
| Scope |
What it covers |
read:content |
View content drafts and publishing connections (/api/content, /api/publishing) |
write:content |
Generate, edit, and publish content |
| Scope |
What it covers |
read:seo |
View audit results, crawler data, SEO tools, Search Console data (/api/audit, /api/quality-seo, /api/seo-tools, /api/search-console, /api/bing-webmaster) |
write:seo |
Run audits, crawls, quality checks; apply fixes; manage schedules |
Tickets & planner
| Scope |
What it covers |
read:tickets |
View tickets, planner tasks, statuses (/api/tickets, /api/planner) |
write:tickets |
Create, update, and transition tickets and tasks |
Integrations
| Scope |
What it covers |
read:integrations |
View channels, conversions, external trackers, webhooks (/api/channels, /api/conversions, /api/notifications) |
write:integrations |
Configure channels, trackers, webhooks, and notification settings |
Brand voice
| Scope |
What it covers |
read:brand-voice |
View brand voice profiles and source documents (/api/brand-voice) |
write:brand-voice |
Create or modify brand voice profiles and connected sources |
Brand restrictions
To create a key scoped to specific brands:
- In the key creation dialog, click Restrict to brands.
- Select the brands this key can access.
- The key will return 404 for data belonging to other brands.
Revoking a key
Click Revoke next to any key in Settings → API. Revocation is immediate. Revoked keys cannot be un-revoked; create a new key if needed.
Key rotation
For security, rotate keys every 90 days or immediately if you suspect a leak. Create the new key, update your integration, then revoke the old key.