Endpoint Playground

Try the Facet the BBB businesses dataset API

Returns the values of one field of the BBB businesses index (dataset id enum value `bbb-businesses`) with the number of records for each, honoring the same filters as search. Facet enum: `country`, `address_country`, `category`, `state`, `city`, `rating`, `accredited`, `entity_type`, `run_id`, `alert_title`, `has_alerts`. The `country` facet is parsed from profile URLs; `address_country` is derived from business addresses. Both enums are `us`, `ca`. Values come most frequent first, 50 per page by default; page through all of them with `limit` (up to 1000) and `offset` while `has_more` is true. The response also returns `total` (records matching the filters), `total_values` (distinct values) and `missing` (records with no value for the facet), so the counts can be checked against the total. Values of the `accredited` and `has_alerts` facets are `1` (true) and `0` (false). Use it to split a search that would exceed 10,000 records: `facet=state` lists every state and province, and `facet=city` with a `state` filter lists every city in it. Dataset Playground requests query indexed data and do not apply proxy routing.

curl "https://api.crawlora.net/api/v1/datasets/bbb-businesses/facets?facet=category&country=us&address_country=us&rating=A%2B" \
  -H "x-api-key: $CRAWLORA_API_KEY"

{
  "code": 200,
  "msg": "OK",
  "data": {
    "dataset": "bbb-businesses",
    "facet": "rating",
    "items": [
      {
        "value": "A+",
        "count": 512
      },
      {
        "value": "A",
        "count": 210
      },
      {
        "value": "A-",
        "count": 88
      },
      {
        "value": "B+",
        "count": 34
      }
    ],
    "total": 900,
    "missing": 56,
    "total_values": 4,
    "limit": 50,
    "offset": 0,
    "has_more": false
  }
}