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

# Facet the GitHub users dataset

`GET /datasets/github-users/facets`

## Request

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

Returns terms aggregation counts for the GitHub users dataset. Facet enum: `influence_tier`, `type`, `country`, `country_code`, `state`, `city`, `domains`, `company`, `reachable`, `has_email`, `has_twitter`, `has_blog`, `active_90d`, `hireable`, `is_org`, `is_bot`, `is_suspected_automation`. influence_tier enum: `nano`, `micro`, `mid`, `macro`, `mega`. Suspected-automation records are excluded by default unless is_suspected_automation is set.

## Query parameters

- `facet` 'influence_tier' | 'type' | 'country' | 'country_code' | 'state' | 'city' | 'domains' | 'company' | 'reachable' | 'has_email' | 'has_twitter' | 'has_blog' | 'active_90d' | 'hireable' | 'is_org' | 'is_bot' | 'is_suspected_automation', required
- `q` string
- `login` string
- `company` string
- `influence_tier` 'nano' | 'micro' | 'mid' | 'macro' | 'mega'
- `country` string
- `country_code` string
- `state` string
- `city` string
- `domain` string
- `has_email` boolean
- `has_twitter` boolean
- `has_blog` boolean
- `reachable` boolean
- `active_90d` boolean
- `hireable` boolean
- `is_org` boolean
- `is_bot` boolean
- `is_suspected_automation` boolean
- `min_followers` integer
- `max_followers` integer
- `min_repos` integer
- `min_rank_score` integer
- `min_account_age_years` number
- `max_account_age_years` number
- `lat` number
- `lon` number
- `radius_m` integer
- `sort` 'relevance' | 'rank_score_desc' | 'followers_desc' | 'account_age_desc' | 'account_age_asc' | 'distance_asc'

## Headers

- `x-api-key` string, required

## Response `200`

OK

- DatasetsGithubUsersFacetResponseDoc
  - `code` integer
  - `data` DatasetsGithubUserFacetResponse
    - `dataset` string: Identifier of the dataset queried (`github-users`).
    - `facet` string: Facet that was aggregated.
    - `items` EsGithubUserDatasetFacetItem[]: Facet values with the number of matching records for each.
      - `count` integer: Number of users with this value.
      - `value` string: Facet value being counted.
  - `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/afac9b012a27?raw)