Skip to content

Ingest event batch

POST
/v1/events/batch

Ingest a batch of events (up to 100).

Duplicate transaction_ids are handled gracefully - existing events are returned without error. The response includes counts of newly ingested vs duplicate events.

EventBatchCreate
object
events
required
Events
Array<object>
>= 1 items <= 100 items
EventCreate
object
transaction_id
required
Transaction Id
string
>= 1 characters <= 255 characters
external_customer_id
required
External Customer Id
string
>= 1 characters <= 255 characters
code
required
Code
string
>= 1 characters <= 255 characters
timestamp
required
Timestamp
string format: date-time
properties
Properties
object
key
additional properties
any

Successful Response

EventBatchResponse
object
ingested
required
Ingested
integer
duplicates
required
Duplicates
integer
events
required
Events
Array<object>
EventResponse
object
id
required
Id
string format: uuid
transaction_id
required
Transaction Id
string
external_customer_id
required
External Customer Id
string
code
required
Code
string
timestamp
required
Timestamp
string format: date-time
properties
required
Properties
object
key
additional properties
any
created_at
required
Created At
string format: date-time

Unauthorized – invalid or missing API key

Billable metric code does not exist

Rate limit exceeded