sites

One site's health, latest crawl, trend and top issues

One site's triage view: its health with the read it rests on, the latest crawl and what it left out, the score trend, the score taken apart, the issue counts and the top open issues by priority. Pass a site id, origin or domain (AMBIGUOUS_SITE when several match: then pass the id). Quote a score with its coverage, never alone; inconclusive means we could not read the site, never that it is healthy. issue_counts counts the whole queue, the ignored included, so an ignored backlog is never invisible. latest_crawl.coverage null means not measured, never nothing left out. Next: issues_list for the full queue, issues_get for one issue's work order.

get/v1/sites/{site}

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}
  • 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.

Response

One site's health, latest crawl, trend and top issues

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.

trend_headlinestring required

How the score moved over the last two complete crawls. Partial crawls are skipped, and scores from different formulas are never compared.

open_issue_countinteger required

Open issues: not resolved, not ignored, not closed as no longer checked.

top_issues_truncatedboolean required

True when more open issues exist than top_issues shows.

Changes

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