Skip to main content
GET
List usage events

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version
enum<string>
default:2025-11-01
required

API version to use. This endpoint currently requires 2025-11-01. Requests without the header, or with any other value, return 400.

Available options:
2025-11-01
Example:

"2025-11-01"

Query Parameters

limit
integer
default:100

Events per page.

Required range: 1 <= x <= 500
cursor
string

The next_cursor from the previous page. Omit it for the first page.

start
string

Start of the window, inclusive. An ISO 8601 timestamp such as 2026-09-23T14:00:00Z, or a date such as 2026-09-21, which reads as midnight UTC. Defaults to 7 days before end. Cannot be more than 12 months ago.

end
string

End of the window, exclusive. Same formats as start. Defaults to the coming midnight UTC, so the default window is the last 7 whole days including today.

api_key_ids
integer[]

Keep only requests made with these API key ids (api_key_id on an event). Repeat the parameter or send a comma-separated list, up to 50.

Maximum array length: 50
Required range: x >= 1
endpoints
string[]

Keep only these endpoints, as they appear in endpoint, for example /person/search. Repeat the parameter or send a comma-separated list, up to 50.

Maximum array length: 50
products
string[]

Keep only these products, as they appear in product, for example person_search. Repeat the parameter or send a comma-separated list, up to 50.

Maximum array length: 50
status
integer[]

Keep only these HTTP status codes, for example status=400,404. Up to 20. On GET /account/usage/summary it needs bucket=1h, or a window that is not whole days.

Maximum array length: 20
Required range: 100 <= x <= 599
status_class
enum<string>

Keep only one status class.

Available options:
2xx,
3xx,
4xx,
5xx
client_surface
string[]

Keep only requests from these surfaces, as they appear in client_surface, for example api or mcp. Repeat the parameter or send a comma-separated list, up to 10.

Maximum array length: 10
error_type
string

Keep only requests that failed with this error_type, for example invalid_request. On GET /account/usage/summary it needs bucket=1h, or a window that is not whole days.

error_key
string

Keep only the requests in one error group. Pass a group's error_key from GET /account/usage/errors exactly as returned.

Maximum string length: 300
hide_free
boolean
default:false

Pass true to hide successful, 0-credit calls to endpoints that never bill: /batch/... submits, /watcher/..., any endpoint ending in /autocomplete, /company/identify, and /screener/identify.

Errors on those endpoints still show. So do searches that matched nothing, and a batch job's completion row, even when the job billed 0 credits. The flag applies even when you filter by endpoints.

Response

One page of events.

One page of usage events, newest first.

events
object[]
required

The events on this page, newest first.

Example:
has_more
boolean
required

true when another page exists.

Example:

true

next_cursor
string | null
required

Pass as cursor to get the next page. null on the last page.

Example:

"MjAyNi0wOS0yM1QxNTowNzo1MS4zMTYwMDArMDA6MDAsZjU2YzIzZDMtYzg3Mi00MDY2LTgwNjMtM2EwMTk2ZjA5NDQ4"