API reference

Generated from the OpenAPI 3.1 specification our tests validate on every response: what is described here is what the API returns.

Account

The token, its team, its plan and its consumption.

• GET /v1/me Describe the current token
• GET /v1/usage Read rate limits and plan quotas
• GET /v1/operations List running operations

Projects

Projects (sites followed over time) and their health scorecard.

• GET /v1/projects List projects
• POST /v1/projects Create a project
• GET /v1/projects/{project} Get a project
• PATCH /v1/projects/{project} Update a project
• DELETE /v1/projects/{project} Delete a project
• GET /v1/projects/{project}/scorecard Get the health scorecard

Campaigns

Reusable crawl configurations and their schedule.

• GET /v1/projects/{project}/campaigns List the campaigns of a project
• POST /v1/projects/{project}/campaigns Create a campaign
• GET /v1/campaigns/{campaign} Get a campaign
• PATCH /v1/campaigns/{campaign} Update a campaign
• DELETE /v1/campaigns/{campaign} Delete a campaign

Crawls

Crawl runs and their results, issues and pages.

• GET /v1/projects/{project}/crawls List the crawls of a project
• GET /v1/crawls/{crawl} Get a crawl
• GET /v1/crawls/{crawl}/issues List issue occurrences
• GET /v1/crawls/{crawl}/issues/summary Summarise issues
• GET /v1/crawls/{crawl}/pages List crawled pages
• GET /v1/crawls/{crawl}/pages/by-url Get a page by URL
• GET /v1/crawls/{crawl}/pagespeed Read PageSpeed results
• GET /v1/crawls/{crawl}/geo Read the GEO readiness report
• GET /v1/crawls/{crawl}/accessibility Read the accessibility report
• GET /v1/crawls/{crawl}/eeat Read the trust foundation report
• GET /v1/crawls/{crawl}/structure Read the internal linking report
• GET /v1/crawls/{crawl}/compare Compare with a baseline crawl
• POST /v1/campaigns/{campaign}/crawls Launch a crawl
• POST /v1/crawls/{crawl}/stop Stop a crawl

Recommendations

AI recommendations, global and per page.

• GET /v1/projects/{project}/recommendations Read AI recommendations
• POST /v1/projects/{project}/recommendations Generate AI recommendations

Exports

PDF reports and Excel workbooks of a crawl, generated asynchronously.

• POST /v1/crawls/{crawl}/exports Request a crawl export
• GET /v1/exports/{export} Get an export
• GET /v1/exports/{export}/download Download an export

Modules

Modules outside the health score (rankings, Search Console, backlinks, security, logs). They carry trends, never a score.

• GET /v1/projects/{project}/positions Read rank tracking
• POST /v1/projects/{project}/tracked-keywords Track keywords
• POST /v1/projects/{project}/tracked-keywords/untrack Stop tracking keywords
• POST /v1/projects/{project}/tracked-keywords/pause Pause tracked keywords
• POST /v1/projects/{project}/tracked-keywords/resume Resume tracked keywords
• POST /v1/projects/{project}/tracked-keywords/check Check a keyword now
• GET /v1/projects/{project}/search-console Read Search Console data
• GET /v1/projects/{project}/backlinks Read the backlink profile summary
• GET /v1/projects/{project}/security Read security signals
• GET /v1/projects/{project}/logs Read server log analysis

Webhooks

Signed outbound events (crawl finished, export ready, recommendations ready, signal detected). Managed by team owners and admins.

• GET /v1/webhooks List webhooks
• POST /v1/webhooks Create a webhook
• GET /v1/webhooks/{webhook} Read a webhook
• PATCH /v1/webhooks/{webhook} Update a webhook
• DELETE /v1/webhooks/{webhook} Delete a webhook
• POST /v1/webhooks/{webhook}/rotate-secret Rotate the signing secret
• POST /v1/webhooks/{webhook}/test Send a test event
• GET /v1/webhooks/{webhook}/deliveries List deliveries