Events
List Events
x-api-key<token>
Authenticate using API Key in request header
In: header
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100eventIDs?array<string>
Items
1 <= itemscallIDs?array<string>
Array with call IDs to filter events by. Formatted as a CSV array.
Items
1 <= itemseventTypes?array<EventType>
Array with event names to filter events by. Formatted as a CSV array.
Items
1 <= itemsfunctionIDs?array<string>
Array with function IDs to filter events by. Formatted as a CSV array.
Items
1 <= itemsfunctionNames?array<string>
Array with function names to filter events by. Formatted as a CSV array.
Items
1 <= itemsreferenceIDs?array<string>
Items
1 <= itemssortOrder?string
Specifies sorting behavior. The two options are asc and desc to sort ascending and descending respectively, with default sort being ascending. Paging works in both directions.
Default
"asc"Value in
"asc" | "desc"startingAfter?string
A cursor to use in pagination. startingAfter is an event ID that defines your place in the list.
endingBefore?string
A cursor to use in pagination. endingBefore is an event ID that defines your place in the list.
isLabelled?boolean
Filters to events that have been labelled.
Response Body
curl -X GET "https://api.bem.ai/v1-alpha/events?limit=50&eventIDs=string&callIDs=string&eventTypes=transform&functionIDs=string&functionNames=string&referenceIDs=string&sortOrder=asc&startingAfter=string&endingBefore=string&isLabelled=true"{
"events": [
{
"eventID": "string",
"referenceID": "string",
"inboundEmail": {
"to": "string",
"from": "string",
"subject": "string"
},
"metadata": {
"durationFunctionToEventSeconds": 0
},
"eventType": "transform",
"functionCallID": "string",
"functionID": "string",
"functionName": "string",
"functionVersionNum": 0,
"callID": "string",
"workflowID": "string",
"workflowName": "string",
"workflowVersionNum": 0,
"transformationID": "tr_2bxoJPNdSD4LgRT4YVC4gt72hlI",
"transformedContent": {},
"invalidProperties": [
"string"
],
"itemOffset": 0,
"itemCount": 0
}
],
"totalCount": 0
}