Skip to navigation
API ReferenceEvents

List Events

View as Markdown

List immutable Events visible in the organization, subaccount and selected Space: every kind of Event, read in one place. Filter by browser, sandbox, Run, Task, Conversation (its history), agent, category (audit logs are the always-on categories), type, actor, channel, outcome or time.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Query parameters

browserstringOptional
Events of this browser, across its Runs.
sandboxstringOptional
Events of this sandbox.
runstringOptional
Events of this Run.
taskstringOptional
Events of this Task.
conversationstringOptional

A Conversation history: its Events.

agentstringOptional
Events of Tasks run by this agent.
categoryanyOptional
typestring or list of stringsOptional
actorstringOptional1-200 characters
Actor ID.
actorTypeenumOptional
Allowed values:
channelanyOptional
outcomeanyOptional
fromdatetimeOptional
RFC 3339 timestamp with a UTC offset.
todatetimeOptional
RFC 3339 timestamp with a UTC offset.
cursorstringOptional
orderenumOptional
Order by createdAt and ID. Defaults to desc.
Allowed values:
limitintegerOptional<=200Defaults to 50

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
datalist of objects
hasMorebooleanDefaults to false
nextCursorstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error