Event
Events are core to Autoblocks. They are the foundation of the insights and analysis the platform allows you to perform.
The event model
The event model has only one required field: message. There are a few other fields you can also send, but they will be given default values if you omit them.
Additionally, you can send any other properties that you would like to track and analyze under the properties field.
Send event
This endpoint sends an event to Autoblocks for processing and returns the traceId associated with the event.
As soon as an event is sent, it is immediately queued for processing. This means that validation happens later, after the event has been queued.
Required fields
- Name
message- Type
- string
- Description
Message of the event
Optional fields
- Name
timestamp- Type
- string
- Description
An ISO date time string of when the event happened. Defaults to when the event was ingested.
- Name
traceId- Type
- string
- Description
Used to group related events together. Defaults to a random UUID.
- Name
properties- Type
- object
- Description
Custom properties to attach to the event. The values in this object can be anything, including other objects.
Request
curl -X POST 'https://ingest-event.autoblocks.ai' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $AUTOBLOCKS_INGESTION_KEY" \
--data '{
"message": "my.event.message"
"properties": {
"myProp": "myValue",
"myNestedProp": {
"x": 1.5,
"y": 2.0,
}
}
}'
Response
{
"traceId": "b3f8c1c0-9b0b-11eb-8dcd-0242ac130003"
}
The send_event and sendEvent methods on the Tracer SDKS are "fire and forget" to maximize performance.
Because of this, trace IDs are not returned in either function.