rules

List the rule catalogue: every check Frontshelf judges by

The rule catalogue: every check Frontshelf can judge a page or a crawl by (the issues a widely used desktop SEO crawler reports, plus Frontshelf's own), each with its tab, type, priority, severity, stage, what it needs, a description and a fix tip. Product data, no crawled content. implemented: false means the rule is catalogued but not yet judging crawls. Pass tab to narrow. With site, the rules whose name carries a number are named with that site's thresholds, and threshold says the value, the catalogue default and which is in force; without it, the catalogue defaults. Pages with cursor; a cut list says so in truncation. Next: rules_get for one rule's predicate, citations and how a fix is verified.

get/v1/rules

Request

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

Query parameters

tabstring

One of the Explorer's tabs in its id form (page_titles, h1, canonicals, accessibility, frontshelf, ...); filters_list names them all.

sitestring

Optional: name a site and the rule names carry its thresholds.

limitinteger

Items per page (1 to 100).

cursorstring

The continuation from a previous page's page_info.next_cursor. Never construct one.

Response

List the rule catalogue: every check Frontshelf judges by

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

True when more rules exist than this page shows.

totalinteger required

Rules matching, on every page together.

Changes

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