API reference
Check a coverage request
The current state of a coverage request by its req_ id (the check_url target). Open: a request page URL works logged out, and the answer never carries the requester. Once status is minted the answer also carries data.resolve, the same resolved entity GET /v1/resolve would give, so a poller needs one call. Never cached. Costs 1 credit.
Path Parameters
request_id*string
req_ + 20 lowercase Crockford base32 chars.
Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/coverage/requests/string"{ "data": { "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" }, "resolve": { "identifier": "string", "input_kind": "identifier", "target": "brand", "result_type": "resolved", "entity": { "slug": "string", "record_available": true }, "tier": "attested", "matched_via": "bixel_id", "why": [ "string" ], "evidence": [ { "type": "capture", "id": "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"}