Request coverage of a domain
Ask Bixel to check whether a domain is company-shaped and worth adding (D22, D24): a request to CHECK, never a mint on ask. The six-part gate decides from stored evidence now (registrable, not a platform tenant, not covered, not already queued, live, within quota); the crawl host probes, banks, names and mints a brand later, and GET /v1/resolve flips to resolved when it lands. Keyless callers get queued_for_capture false with queue_reason account_required and the web request page (one anonymous request a day lives there); nothing is written for them. Quotas: free 5 a day, paid rungs uncapped with queue priority; counters reset 00:00 UTC. Costs 1 credit; the queue itself draws none. What the check accepts (10/21): a site that lives at another domain is added under the domain it lands on (the request answers lands_on:); a JavaScript-rendered site is judged on its rendered page; a live site on its own domain that runs its own mail is taken at the asker's word. The record is read after its live pages are captured. A keyed ask for a company the registry already knows (answer covered) also adds it to your coverage inside your allowance and queues a fresh read of its pages; data.coverage says what happened (admitted, charged, already_covered, beyond_allowance, refused, not_admitted). Beyond the allowance nothing is billed: cover it through a watch with cover_beyond_allowance. Landing times measured 10/22: two to three minutes for a company already in the identity layer, three to six for one never seen. The answer never carries the record itself; fetch it with GET /v1/companies/{company} once it lands.
bx_-prefixed API key. Free keys: https://bixel.com/account/
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/coverage/requests" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "queued_for_capture": true, "request_id": "string", "check_url": "string", "expected_by": "2019-08-24T14:15:22Z", "queue_reason": "account_required", "request_page_url": "string", "request": { "request_id": "string", "input": "string", "apex_domain": "string", "status": "queued", "gate_verdict": "admitted", "gate_reason": "string", "outcome_reason": "string", "bixel_id": "string", "capture_ref": "string", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "check_url": "string" }, "covered": true, "reason": "string", "cap": 0, "resets_at": "2019-08-24T14:15:22Z", "coverage": { "outcome": "admitted", "request_id": "string", "note": "string" } }, "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"}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}