sites

List the sites this key can see, with health

Every site this key can see, each with its health, what lowers its score, its billing state and its latest crawl. Call it first: it gives the site ids the other capabilities take (a domain works too). A site missing here means this key cannot reach it, not that it does not exist. Quote a score with health.coverage beside it, never alone: it is a claim about the pages the crawl read. A null score or inconclusive is never a healthy site, and zero findings is never evidence of health. A site with billing.read_only refuses crawls and verification: give your human billing.checkout_url. Next: sites_get for one site's detail, issues_list for its issue queue.

get/v1/sites

Request

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

Response

List the sites this key can see, with health

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.

truncatedboolean required

Always false today: the list is never cut.

totalinteger required

How many sites this key can see.

Changes

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