Usage this period
Consumption by billing unit for the current period, in total and per key. Updated within five minutes of each request.
anybilling unitfreeagent notesFree. Read `period.included` minus `period.used` per unit to size a batch. Per-key rows include revoked keys that spent units this period so the totals reconcile.
Consumption by billing unit for the current period, in total and per key. Updated within five minutes of each request.
Authorization
ApiKey Workspace API key as a bearer token. Create keys in the dashboard under Settings → API keys. Test keys (oai_test_) answer from a fixed test tenant and never queue production scans.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/usage"{ "by_key": [ { "key_id": "string", "label": "string", "used": { "history_query": 0, "lookup_cached": 0, "lookup_live": 0, "refresh_requested": 0 } } ], "period": { "ends_at": "2019-08-24T14:15:22Z", "included": { "history_query": 0, "lookup_cached": 0, "lookup_live": 0, "refresh_requested": 0 }, "starts_at": "2019-08-24T14:15:22Z", "used": { "history_query": 0, "lookup_cached": 0, "lookup_live": 0, "refresh_requested": 0 } }}Validate the key and discover capabilities GET
Returns the workspace, the key used for this request, the plan limits in force, and the current billing period. Make this the first call of any integration: it tells you which scopes you hold and how much allowance remains before you spend any of it.
Enrich up to 100 domains POST
Batch form of the store profile. Each input is canonicalized and answered independently; the response preserves input order. Matched and stale inputs return the full store object. No-match inputs return a reason and are not billed. With `refresh: true` and the `write:scans` scope, unknown or stale domains are queued for observation and the result is marked `scan_requested`.