reports

List the report catalogue, with a site's row counts

Every report Frontshelf exports from a committed crawl (links, images, security, canonicals, hreflang, JavaScript, sitemaps, structured data, Lighthouse, accessibility, chains, URL Inspection, the crawl and issues overviews) plus the branded PDF, each with its id and the exact header row it writes. Without site it is free and reads no crawl. With site (and crawl_seq) each report carries rows for that crawl, as the Reports screen shows: rows: null is not counted yet, never zero, and counts says whether counting is done. A report whose source the crawl did not join is rows: null with unavailable; one with parts missing carries note. Filter with group. Next: reports_export with a report id for a download link.

get/v1/reports

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/reports
  • Auth: HTTP bearer

Query parameters

sitestring

Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID. Pass it for each report's row count on one committed crawl; omit for the catalogue alone (free, reads no crawl).

crawl_seqinteger

Which committed crawl to count; omit for the site's current accepted crawl. Read only with site.

groupstring

Only reports in this group (links, images, security, ...).

Response

List the report catalogue, with a site's row counts

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

crawl_seqinteger

With a site: the crawl counted.

crawl_run_idstring

With a site: that crawl's run id.

groupsstring[] required

Every group, for group.

Changes

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