rules

One rule in full: what it checks, why, how to fix it, how a fix is verified

One rule from the catalogue, in full: what it checks (predicate), the URLs and gates it applies to, its thresholds with defaults, citations, where Frontshelf deliberately differs from a widely used desktop SEO crawler (delta_from_sf), and how a fix is verified (verification_mode: http_probe re-fetches the affected pages live, full_crawl waits for the next committed crawl; only the verifier resolves an issue). Name it by catalogue id, desktop-crawler filter key or filter-key id; NOT_FOUND means no such rule, and rules_list names them. With site, a rule whose name carries a number is named with that site's threshold. Next: pages_list with site and the rule's id as filter for the pages it fired on.

get/v1/rules/{rule}

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/rules/{rule}
  • Auth: HTTP bearer

Path parameters

rulestring required

A rule by catalogue id (metadata.missing_title), its desktop-crawler filter key (TITLE_MISSING, any case) or its filter-key id (37).

Query parameters

sitestring

Optional: name a site and the rule's name and threshold carry its value.

Response

One rule in full: what it checks, why, how to fix it, how a fix is verified

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.

Changes

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