Datasets API endpoint
Returns value counts for the Facebook Pages dataset, by the required `facet`: `category` or `discovery_source`. Search filters such as `q`, `min_likes` and `has_email` narrow the counts. Default order is most common first; `order=value_asc` pages alphabetically using `after` and `next_after`, with `limit` up to 200.
/datasets/facebook-pages/facetsReturns terms aggregation counts for the Facebook Pages dataset under search filters.
Dataset id enum:
facebook-pagesQuery parameters:
facet: required facet field enum: category, discovery_source.limit: optional number of values, default 50, maximum 200.order: optional enum count_desc (default) or value_asc. Use value_asc to discover the full value space.after: optional continuation value from next_after; requires order=value_asc. Keep the facet and all filters unchanged between requests.sort: optional sort enum: relevance, likes_desc, likes_asc, hydrated_at_desc, hydrated_at_asc.q, page_id, identifier, category, discovery_source, has_website, has_email, has_phone, has_whatsapp, min_likes, max_likes, hydrated_after, hydrated_before: same filters as search.Response behavior:
facet parameter must be one of the documented enum values; invalid values return 400.order=value_asc returns values alphabetically and exposes next_after. Continue until it is absent; the final request may be empty. Counts can change as Pages are refreshed.To enumerate categories, start with /api/v1/datasets/facebook-pages/facets?facet=category&order=value_asc&limit=200, then URL-encode next_after into the next request’s after parameter.
| Field | Filled in, of 3 checked | Values in the sample |
|---|---|---|
| value | 3 | |
| count | 3 | 33,322 to 986,661, median 514,107 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| limit | integer | No | Facet values per response, default 50, maximum 200 | ||
| order | string | No | count_desc returns most common values; value_asc pages through all values Allowed values: count_desc, value_asc. | ||
| after | string | No | Continuation from next_after; requires order=value_asc and unchanged filters | ||
| facet | string | Yes | Facet enum: category, discovery_source Allowed values: category, discovery_source. | category | |
| q | string | No | Full-text query over title and address, max 256 characters | ||
| page_id | string | No | Exact Facebook Page id filter, max 128 characters | ||
| identifier | string | No | Exact Page username/identifier filter (case-insensitive), max 128 characters | ||
| category | string | No | Exact Page category filter (case-insensitive), max 128 characters | ||
| discovery_source | string | No | Exact filter for how the Page was discovered (e.g. business_search, warc_domain_scan, wikidata), max 128 characters | ||
| has_website | boolean | No | Filter by a linked website | ||
| has_email | boolean | No | Filter by a public contact email | ||
| has_phone | boolean | No | Filter by at least one public phone number | ||
| has_whatsapp | boolean | No | Filter by a public WhatsApp contact | ||
| min_likes | integer | No | Minimum Page like count | ||
| max_likes | integer | No | Maximum Page like count | ||
| hydrated_after | string | No | Records last refreshed on or after this date (RFC3339 or YYYY-MM-DD) | ||
| hydrated_before | string | No | Records last refreshed on or before this date (RFC3339 or YYYY-MM-DD) | ||
| sort | string | No | Sort enum: relevance, likes_desc, likes_asc, hydrated_at_desc, hydrated_at_asc Allowed values: relevance, likes_desc, likes_asc, hydrated_at_desc, hydrated_at_asc. | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/datasets/facebook-pages/facets?limit=10&order=count_desc&facet=category&q=coffee&has_website=true&has_email=true&has_phone=true&has_whatsapp=true&sort=relevance" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"dataset": "facebook-pages",
"facet": "category",
"items": [
{
"value": "Shoe Store",
"count": 42
},
{
"value": "Restaurant",
"count": 37
},
{
"value": "Clothing (Brand)",
"count": 29
}
]
}
}Request schema
No body schema
Response schema
#/definitions/datasets.facebookPagesFacetResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | datasets.FacebookPageFacetResponse | No | ||||
| data.dataset | string | No | ||||
| data.facet | string | No | ||||
| data.items | array | No | ||||
| data.items[].count | integer | No | ||||
| data.items[].value | string | No | ||||
| data.next_after | string | No | ||||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/datasets/facebook-pages/facets?limit=10&order=count_desc&facet=category&q=coffee&has_website=true&has_email=true&has_phone=true&has_whatsapp=true&sort=relevance" \
-H "x-api-key: $CRAWLORA_API_KEY"