Reports
Read the reports shared with a workspace, their comment threads, and their PDF.
These endpoints need the reports scope and only read. Posting comments, resolving threads and creating share links are done in the dashboard. Only shared reports in a workspace the caller belongs to are returned; a draft, a report in another workspace and an unknown id all answer 404.
List reports
GET /v1/reports?workspace_id={id}The reports shared with the workspace, newest first. Each has id, title, version, sharedAt, updatedAt, unread (not read since the last change) and openThreads (unresolved comment threads).
Read a report
GET /v1/reports/{id}The report with its rendered html and its blocks. Every top-level element in the HTML carries a data-block-id, and each block gives its id and plain text, which is what comment anchors count characters into. Charts are inline SVG or tables.
Comment threads
GET /v1/reports/{id}/commentsTop-level comments newest first, each with its replies oldest first. A comment has its body, an anchor to the passage it was made on (the report version, blockId, start and end offsets and the quoted text) or null, its author with isTeam set when the RankDebug team wrote it, and resolvedAt.
Download as PDF
GET /v1/reports/{id}/pdfThe report as an A4 PDF. Answers 503 with pdf_unavailable when PDF export is not available.
Related documentation
- Overview
Base URL, authentication, scopes, errors and rate limits for the RankDebug API.
- API Keys and Scopes
Create API keys, limit them with scopes and a workspace binding, and keep them safe.
- Workspaces
List, create, update and delete workspaces, and read a workspace's request logs and activity.
- Search
Search Console performance, top rows, opportunities and sitemaps for a workspace.
- Traffic
Google Analytics landing pages, acquisition and measurement health, and CDN crawler traffic, error paths and firewall rules.
- Deploys
Record deploys from CI, list them, and read one deploy with its site check, crawl and search impact.
- Site Crawls
Read crawls of the workspace website, their findings, and every page of one finding.
- Digests
Read what the latest scheduled digest email for a workspace contained.