API Keys
VisibilityIQ’s public REST API lets you integrate audit data, backlink profiles, and keyword rankings into your own tools, dashboards, or CI/CD pipelines. Access is authenticated via API keys.
Generating an API key
Section titled “Generating an API key”Go to Account → API Keys and click Create API key. Give it a descriptive name (e.g., “CI pipeline”, “Looker Studio integration”) and select the scopes it needs access to.
Your key is shown once when created — copy it immediately. It cannot be retrieved again. If you lose it, revoke the key and create a new one.
Scopes
Section titled “Scopes”API keys have scope-limited access. Available scopes:
| Scope | Access |
|---|---|
audit:read | Read audit findings and crawl results |
projects:read | List and read project details |
backlinks:read | Access backlink profile endpoints |
rankings:read | Access keyword ranking data |
connectors:read | Read connector sync status and data |
Grant only the scopes your integration needs.
Using your API key
Section titled “Using your API key”Include it in the Authorization header of every API request:
Authorization: Bearer vis_live_YOUR_KEY_HEREFull API documentation is at help.visibilityiq365.com/developers/api/.
Rate limits
Section titled “Rate limits”API keys are rate-limited per endpoint. Limits are documented in the API reference. If you exceed the limit, you’ll receive a 429 Too Many Requests response with a Retry-After header indicating when you can try again.
Rotating or revoking a key
Section titled “Rotating or revoking a key”To rotate a key: create a new key, update your integrations to use the new key, then revoke the old one. Revoking a key is immediate — any requests using the old key will start receiving 401 Unauthorized responses.
Go to Account → API Keys, find the key, and click Revoke. Revoked keys cannot be un-revoked.
Security
Section titled “Security”- Never commit API keys to source control. Use environment variables or a secrets manager.
- Scope keys to the minimum access needed.
- Rotate keys if you suspect they’ve been exposed.
- Use separate keys for separate integrations so you can revoke one without breaking others.