API reference
Check a company read
The state of your account's latest read of the company (queued, running, done, failed, or fresh when it was served from the window), what it settled as (charged, no_charge, refused) and whether the record is currently fresh: last_read_at is the newest landed read of the company by anyone, fresh is true inside the 7-day window. Ask this before POST so you never pay for a read you do not need. Costs 1 credit.
AuthorizationBearer <token>
bx_-prefixed API key. Free keys: https://bixel.com/account/
In: header
Path Parameters
company*string
Apex domain (canonical, e.g. pinecone.io). Bare values are resolved as legacy slugs. Unknown names: resolve via /v1/search first.
Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/companies/pinecone.io/reads"{ "data": { "company": { "domain": "string" }, "fresh": true, "fresh_window_days": 0, "last_read_at": "2019-08-24T14:15:22Z", "read": { "status": "fresh", "request_id": "string", "check_url": "string", "read_at": "2019-08-24T14:15:22Z", "credits_due": 0, "credits_charged": 0, "settlement": "charged", "requested_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "continues_as": "read_once", "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"}