---
title: "The census sampling frame: the Tranco list id and configuration, the members measured, and the counts excluded by the publish filter and by opt-out"
method: GET
path: "/api/census/frame"
---

# The census sampling frame: the Tranco list id and configuration, the members measured, and the counts excluded by the publish filter and by opt-out

`GET /api/census/frame`

## Request

- Base URL: `https://crawlcheck.io`
- URL: `https://crawlcheck.io/api/census/frame`
- Auth: none required

## Response `200`

crawlcheck-census-frame

- object, nullable
  - `ok` boolean, nullable
  - `v` number, nullable
  - `kind` string, nullable
  - `source` string, nullable
  - `list_id` string, nullable
  - `list_url` string, nullable
  - `list_created_on` string, nullable
  - `list_configuration` object, nullable
    - `listPrefix` string, nullable
    - `combinationMethod` string, nullable
    - `isDailyList` boolean, nullable
    - `providers` string[], nullable
    - `filterTLD` string, nullable
    - `startDate` string, nullable
    - `endDate` string, nullable
    - `filterPLD` string, nullable
  - `requested` number, nullable
  - `members` object[], nullable
    - `rank` number, nullable
    - `domain` string, nullable
  - `excluded` object, nullable
    - `publish_filter` number, nullable
    - `opted_out` number, nullable
  - `frozen_at` string, nullable
  - `rule` string, nullable

---

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