v1

latestOpenAPI 3.0.02026-07-26392662.9 KB

Usage

Get IP-to-Company (Reveal API) credit usage

Returns billable IP-to-Company usage for the current billing cycle, per tracking script. A unit is a distinct successful (HTTP 200) de-anonymisation deduped per (tracking script, monthly window) — the exact figure billing charges a credit for. Operators reconcile this per cycle to know which lookups were billed.

get/radar/operator/v1/company/usage

Response

Usage data retrieved successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "usageCycleFrom": "2023-01-01T00:00:00+00:00",
    "usageCycleTo": "2023-12-31T23:59:59+00:00",
    "revealUsage": 12345,
    "trackingScriptUsages": [
      {
        "trackingScriptId": "ro_abc123",
        "revealUsage": 5678
      }
    ]
  }
}