BixelDocs
API reference

Corpus census counts

GET
/v1/census

How much Bixel covers, as counts of disjoint layers: domains tracked for liveness, those with a dated probe, registry-born legal entities, crawl-born brands, self-published cross references, and legal-identity declarations. Each number says how it was taken (exact, or the database planner's whole-table estimate while the exact function is not yet installed). Refreshed every thirty minutes on the crawl host (one exact pass counts about sixteen million rows); the response says when it was counted and flags itself stale past forty-five minutes. Open tier, costs 0 credits, cached at the edge for a minute. A count that could not be taken is null.

Response Body

application/json

application/problem+json

curl -X GET "https://example.com/v1/census"
{  "data": {    "schema_version": "census/1",    "as_of": "2019-08-24T14:15:22Z",    "counts": {      "tracked": 0,      "liveness_observed": 0,      "legal_entities": 0,      "brands": 0,      "cross_refs": 0,      "declarations": 0    },    "registry_total": 0,    "labels": {      "property1": "string",      "property2": "string"    },    "stale": true,    "methods": {      "property1": "exact",      "property2": "exact"    }  },  "meta": {    "generated_at": "2019-08-24T14:15:22Z",    "count": 0,    "total": 0,    "next_cursor": "string",    "notice": "string",    "window": {      "served_from": "string",      "earliest_event_at": "string",      "events_beyond_window": true    },    "data_version": "string",    "resolved_at": "2019-08-24T14:15:22Z",    "attribution": {      "source": "Bixel",      "url": "string",      "license": "CC-BY-4.0",      "notice": "from Bixel",      "data_version": "string"    }  }}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}