---
title: "Facet the X users dataset"
method: GET
path: "/datasets/x-users/facets"
tags: ["Datasets"]
---

# Facet the X users dataset

`GET /datasets/x-users/facets`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/datasets/x-users/facets`
- Auth: API key in header `x-api-key`

Returns value counts for the X users dataset by the required `facet`: `is_blue_verified`, `has_bio`, `has_external_url` or `source_tier`. The counts follow the search filters, including `q`, follower and ratio ranges, and creation or crawl dates. At most 50 values come back, largest count first.

## Query parameters

- `facet` 'is_blue_verified' | 'has_bio' | 'has_external_url' | 'source_tier', required
- `q` string
- `username` string
- `source_tier` string
- `is_blue_verified` boolean
- `has_bio` boolean
- `has_external_url` boolean
- `min_followers` integer
- `max_followers` integer
- `min_ratio` number
- `max_ratio` number
- `created_after` string
- `created_before` string
- `crawled_after` string
- `crawled_before` string
- `sort` 'relevance' | 'followers_desc' | 'followers_asc' | 'crawled_at_desc' | 'crawled_at_asc' | 'created_at_desc' | 'created_at_asc'

## Headers

- `x-api-key` string, required

## Response `200`

OK

- DatasetsXUsersFacetResponseDoc
  - `code` integer
  - `data` DatasetsXUserFacetResponse
    - `dataset` string: Identifier of the dataset queried (`x-users`).
    - `facet` string: Facet that was aggregated.
    - `items` EsXUserDatasetFacetItem[]: Facet values with the number of matching records for each.
      - `count` integer: Number of X users in this bucket.
      - `value` string: Bucket value for the requested facet, such as `true` or `false` for yes/no facets.
  - `msg` string

## Other responses

- `400`: Bad Request
- `429`: Too Many Requests
- `500`: Internal Server Error

---

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