Skip to main content
GET
Coverage report
matched counts every lookup that returned a classification other than unknown or suspected_vpn, hosting and cdn included, so coverage_pct is the share of your lookups that got a category label. It is not a detection rate. The fractions run from 0 to 1: 0.5 means 50%.

Authorizations

apiKey
string
query
required

Your API key, passed as the apiKey query parameter on every request. A key sent in a header (Authorization or X-API-Key) is not accepted and gets 401.

Response

Successful Response

customer_ref
string

An opaque identifier for the API key this report covers. It does not change between calls.

window_days
integer

Always 30: the report covers the trailing 30 days.

queried
integer

Lookups made with your API key in the last 30 days. The count is approximate: a lookup can occasionally go unrecorded. 0 can also mean the report could not be read this time; call again later.

Required range: x >= 0
matched
integer

Of those, the lookups that returned a classification other than unknown or suspected_vpn, hosting and CDN included.

Required range: x >= 0
coverage_pct
number | null

matched divided by queried, as a fraction from 0 to 1 (0.5 means 50%), to 4 decimal places. Null when queried is 0.

Required range: 0 <= x <= 1
wow_trend
object

The same fraction for the last 7 days and for the 7 days before them.

residential_proxy
object