Developer docs
API keys and scopes
A key is a person's access, narrowed to websites and scopes. Make it as small as the job needs.
Two kinds of keys
| Key | Made in | Covers | Prefix |
|---|---|---|---|
| Workspace key | Settings → Developer access → New key | every website, or the ones you tick | mr_ws_… |
| Website key | made when the WordPress plugin connects | one website | mr_site_… |
Settings are for your own websites. For a workspace someone shares with you, open its settings from ⋯ on its group in the Websites list (only if you may change them). Use a workspace key for your own scripts and assistants, and tick only the websites it needs. Both kinds are listed under Settings → Developer access with their last use, so you can spot unused ones. Each key is shown once and limited to 1,200 requests an hour.
Scopes
When you make or edit a key, the app lists the scopes under What it may do, with the plain label shown here.
| Scope | Label in the app | Allows |
|---|---|---|
sites:read |
Read website details and scores | website summary, scores and history, speed results, the portfolio of all the key’s websites, audits |
pages:read |
Read pages and findings | crawled pages, findings per page and page history |
issues:read |
Read issues and actions | issues with evidence, AI explanations, suggested values, prioritized actions |
search:read |
Read search performance | Search Console summary and rows, topics, keywords, competitors and keyword gaps, backlinks, and outreach targets |
analytics:read |
Read Google Analytics conversions and revenue | conversions and revenue per landing page from the website’s Google Analytics (GA4) |
ai:read |
Read AI visibility and AI readiness | AI visibility, answer gaps, AI crawler access, llms.txt and Agentic browsing results |
content:write |
Send content and change alerts | used by the WordPress plugin to send content; not for your own scripts |
issues:recheck |
Start rechecks | queue a recheck, or re-run the Agentic browsing check for one page |
audits:run |
Start audits | start a full audit (reading audits needs sites:read) |
actions:apply |
Apply approved fixes to the website | approve SEO title, description, canonical or noindex changes, llms.txt and AI crawler rules, written through the WordPress connector; set the status and note of an outreach target; pick, dismiss or add competitors |
The key the WordPress plugin uses carries content:write plus sites:read and pages:read, so it can also read this website’s scores back for its own screens.
Change a key
Edit on a key changes its name, its scopes and, for a workspace key, its websites. The key itself stays the same, so nothing needs a new copy. A website key stays on its website. A key the WordPress plugin uses keeps its name and the scopes it needs. Keys made before a scope existed (for example ai:read, audits:run or analytics:read) do not have it: add it with Edit.
OAuth tokens
When an MCP client signs you in instead of taking a key (ChatGPT, for example), you approve its access once. It can ask for these scopes only: sites:read, pages:read, issues:read, search:read, analytics:read, ai:read and issues:recheck. So it can read and queue rechecks, but it can never start audits, write changes to your website, update outreach targets or change competitors (audits:run, actions:apply and content:write are never granted this way).
Behind the token is a workspace key named after the client, for example “ChatGPT (OAuth)”. It appears in the same list under Settings → Developer access and is revoked the same way. Access tokens last an hour and are renewed by the client; if you do not use the client for 30 days, it asks you to sign in again. A connection made before analytics:read existed does not have it: connect the client again to add it.
Revoking
Settings → Developer access → Revoke on the key. Requests with it fail with 401 from that moment. The WordPress plugin’s key can also be revoked there; the plugin then shows “disconnected” and stops sending.
Common questions
I lost a key. Can I see it again?
No. MonoRanks keeps only a fingerprint. Revoke it and make a new one.
Can I give an existing key more access?
Yes. Edit on the key changes its name, scopes and websites. The key itself stays the same, so nothing that uses it needs a new copy.
Who can make keys?
Everyone, for their own websites. In a shared workspace, only the owner and members who see all websites. A key never reaches past what its creator can see, and stops working if its creator becomes a client viewer or leaves the workspace.