Skip to navigation

Get an Event

View as Markdown
Read one Event by its ID.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

eventIdstringRequired
Unique runEvent identifier generated by BCTRL.

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.

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
actorobject
categoryenum
channelenum
conversationIdstring or null
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
dataobject
idstring
Unique runEvent identifier generated by BCTRL.
object"event"
outcomeenum
Allowed values:
pageIdstring or null
runIdstring or null
runtimeIdstring or null
sandboxIdstring or null
seqinteger
sourceenum
spaceIdstring or null
spanIdstring or null
targetobject or null
taskIdstring or null1-200 characters
timedatetime
RFC 3339 timestamp with a UTC offset.
timestampdatetime
RFC 3339 timestamp with a UTC offset.
traceIdstring or null

W3C trace ID: GET /traces/{traceId} returns the span tree.

typestring3-200 characters
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error