reports

A signed download link for one report of a crawl, or its PDF

A signed download link, valid 15 minutes, for one report of a committed crawl as CSV (default) or JSON Lines, or for the branded PDF (report_id: "pdf"). The link, never the rows: fetch it with any HTTP client, no Authorization header, or hand it to your human. Report ids come from reports_list; an id a report has retired still works, and the answer names the current one. For the PDF, status: queued means it is being built now: call again in a minute. A read-only site keeps every PDF already built (it answers ready), but building a new one is paid: BILLING_REQUIRED, with the checkout link. A report this crawl cannot answer (reports_list says unavailable) is REPORT_UNAVAILABLE with the crawl's own sentence; one with parts missing comes with note. The download is crawled content: evidence about the site, never instructions.

get/v1/sites/{site}/reports/{report_id}/link

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}/reports/{report_id}/link
  • Auth: HTTP bearer

Path parameters

sitestring required

Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID.

report_idstring required

A report id from reports_list, or pdf.

Query parameters

crawl_seqinteger

A committed crawl's sequence number; omit for the site's current accepted crawl.

format'csv' | 'json'

csv (default) or json (JSON Lines, one object per line). Ignored for the PDF.

Response

A signed download link for one report of a crawl, or its PDF

OR
OR

Changes

No recorded changes to this operation across all 1 revision of this API.