---
title: "List the Explorer's tabs and every filter on them, the names pages_list filters by"
method: GET
path: "/v1/filters"
tags: ["filters"]
---

# List the Explorer's tabs and every filter on them, the names pages_list filters by

`GET /v1/filters`

## Request

- Base URL: `https://frontshelf.io/api`
- URL: `https://frontshelf.io/api/v1/filters`
- Auth: HTTP bearer

The Explorer's tabs as named queries, in the order a widely used desktop SEO crawler shows them: each tab with every filter the Explorer shows, issue filters (kind `issue`: a catalogue rule, with its type, priority and stage) and stat views (kind `stat`: the desktop-crawler key, such as RESPONSE_CODE_SUCCESS), each with the `id` and `filter_key_id` that pages_list takes as `filter`. Product data, no crawled content. Pass `tab` for one tab; an unknown tab is INVALID_FILTER naming them all. Pass `site` to name the issue filters with that site's thresholds instead of the catalogue defaults (the filters whose name carries a number) and to get its Custom Extraction and Custom Search view filters (`view_filters`). Next: pages_list with `site` and `filter` for the pages on one; rules_get for what a rule checks.

## Query parameters

- `tab` string: One tab in id form (page_titles, h1, canonicals, custom_extraction, frontshelf, ...).
- `site` string: Optional: a site whose thresholds name the issue filters and whose custom view filters are listed.

## Response `200`

List the Explorer's tabs and every filter on them, the names pages_list filters by

- object
  - `summary` string, required: The answer in one or two sentences, with the numbers it rests on.
  - `warnings` string[], required: What limits this answer (a cap, a read that was cut short). Empty when nothing does.
  - `next_actions` object[], required: What to call next, best first. Follow them.
    - `capability` string, required: What to call next: a capability.
    - `arguments` object, required: Its arguments, complete; pass them as they are.
    - `instruction` string, required: What to do, written to you.
  - `tabs` object[], required: The tabs, in the order a widely used desktop SEO crawler shows them, then Frontshelf's own.
    - `tab` string, required: The tab in id form (page_titles); `tab` takes it.
    - `sf_tab` string, nullable, required: The tab's name in a widely used desktop SEO crawler; null for Frontshelf's own tab.
    - `label` string, required: The tab as the Explorer shows it (Page Titles).
    - `filters` object[], required: The tab's issue filters, then its stat views.
      - `id` string, required: What `pages_list` takes as `filter`: a rule's catalogue id, or a stat view's key.
      - `kind` 'issue' | 'stat', required: `issue`: a catalogue rule; `stat`: an Explorer view that is not an issue.
      - `filter_key_id` integer, required: The frozen number the filter is stamped on pages by; `filter` takes it too.
      - `sf_key` string, nullable, required: The desktop-crawler filter key; null for Frontshelf's own rules.
      - `name` string, required: The filter's name; a number in a rule's name is the threshold in force.
      - `type` 'issue' | 'warning' | 'opportunity', nullable, required: The classification a widely used desktop SEO crawler gives the rule; null for a stat view.
      - `priority` 'high' | 'medium' | 'low', nullable, required: The priority a widely used desktop SEO crawler gives the rule; null for a stat view.
      - `stage` 'page' | 'analysis' | 'spelling' | 'integration', required: When the filter is judged: `page` on one page, `analysis` across the crawl, `spelling` by the spelling pass, `integration` from a connected service.
    - `view_filters` object[]: Only on the custom_extraction and custom_search tabs, and only with `site`: one view filter per extractor or search the site defines.
      - `filter_key` string, required: The view filter's key, as an Explorer export takes it.
      - `name` string, required: The extractor or search it belongs to, as the site's settings name it, or Contains Data / Does Not Contain Data.

## Other responses

- `400`: INVALID_FILTER, VALIDATION_FAILED
- `401`: UNAUTHENTICATED
- `403`: SCOPE_DENIED
- `404`: SITE_NOT_FOUND
- `409`: AMBIGUOUS_SITE, AGENT_STOPPED
- `503`: DEPENDENCY_UNAVAILABLE

---

[API](https://skmtc.dev/frontshelf/apis/frontshelf-api.md) · [All operations](https://skmtc.dev/frontshelf/apis/frontshelf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/frontshelf/apis/frontshelf-api/revisions/ce3602d26c7c?raw)