Every request needs your Reporting API token in the
Authorization header, formatted as token {your-token}—the literal string token, a space, then the token. Find it under Account > Account tab > Integration Tokens. See Authentication for the full setup, including the Terms of Use you need to accept first.Start with List websites. Almost every other request takes a
website_id, and that endpoint is where you get it.Endpoints
Entities
- List websites -
GET /v2/entities/websites - List segments for a website -
GET /v2/entities/segments
Data
- Get statistics -
GET /v2/data/statistics - List pages for a website -
GET /v2/data/pages - Get page data -
GET /v2/data/page - Get log file analysis data -
GET /v2/data/page_lfa - List issues for a website -
GET /v2/data/issues - List affected pages for an issue -
GET /v2/data/affected_pages - Get page issue details -
GET /v2/data/page/issues - Get page broken links -
GET /v2/data/page/issues/broken_links - Get page redirected links -
GET /v2/data/page/redirected_links - Get page canonicalized links -
GET /v2/data/page/issues/canonicalized_links
Alerts
- List alerts for a website -
GET /v2/alerts - List pages for an alert -
GET /v2/alerts/alert_pages
Rate limits
The Reporting API allows 6 requests per second per requester IP address. Exceeding that returns429 for one minute. There is no cap on the total number of calls you can make.