Datasets

Facet the Facebook Pages dataset

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.

get/datasets/facebook-pages/facets

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/facebook-pages/facets
  • Auth: API key in header x-api-key

Query parameters

limitinteger

Facet values per response, default 50, maximum 200

order'count_desc' | 'value_asc'

count_desc returns most common values; value_asc pages through all values

afterstring

Continuation from next_after; requires order=value_asc and unchanged filters

facet'category' | 'discovery_source' required

Facet enum: category, discovery_source

qstring

Full-text query over title and address, max 256 characters

page_idstring

Exact Facebook Page id filter, max 128 characters

identifierstring

Exact Page username/identifier filter (case-insensitive), max 128 characters

categorystring

Exact Page category filter (case-insensitive), max 128 characters

discovery_sourcestring

Exact filter for how the Page was discovered (e.g. business_search, warc_domain_scan, wikidata), max 128 characters

has_websiteboolean

Filter by a linked website

has_emailboolean

Filter by a public contact email

has_phoneboolean

Filter by at least one public phone number

has_whatsappboolean

Filter by a public WhatsApp contact

min_likesinteger

Minimum Page like count

max_likesinteger

Maximum Page like count

hydrated_afterstring

Records last refreshed on or after this date (RFC3339 or YYYY-MM-DD)

hydrated_beforestring

Records last refreshed on or before this date (RFC3339 or YYYY-MM-DD)

sort'relevance' | 'likes_desc' | 'likes_asc' | 'hydrated_at_desc' | 'hydrated_at_asc'

Sort enum: relevance, likes_desc, likes_asc, hydrated_at_desc, hydrated_at_asc

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.