Skip to navigation
API ReferenceUsage and cost trackingEvents

List events

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

customer_idstringOptional
Only objects belonging to this customer.
namestringOptional
Only events with this name.
referencestringOptional
Only events with this reference.
run_idstringOptional
Only events from this run.
kindenumOptional
Only events of this kind.
Allowed values:
warningstringOptional
Only events that returned this warning code.
test_clockstringOptional
Sandbox only. Only events for customers on this test clock.
created_afterdatetimeOptional
Only objects created at or after this time.
created_beforedatetimeOptional
Only objects created before this time.
limitintegerOptional1-100Defaults to 20
Maximum number of objects to return, from 1 to 100.
cursorstringOptional

The next_cursor from the previous page.

includeenumOptional

Send total_count to add total_count to the list: how many objects match the filters across every page. The count is capped, and total_count_approximate: true says when the real number is higher. It is slower than a plain list, so ask for it when you show a number.

Allowed values:

Response

A page of events.
object"list"
datalist of objects
has_moreboolean
next_cursorstringOptional
total_countintegerOptional

Only with include=total_count. How many objects match the filters.

total_count_approximatebooleanOptional

Only with include=total_count. True when the count was capped and the real number is higher.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error