Skip to main content
POST
/
v1
/
events
/
ingest
Ingest events
curl --request POST \
  --url https://api.useaira.com/v1/events/ingest \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "events": [
    {
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "eventName": "api_request",
      "customerExternalId": "cust_1234567890abcdef",
      "properties": {
        "value": 3600,
        "endpoint": "/api/v1/users",
        "method": "GET",
        "status_code": 200
      },
      "occurredAt": "2024-01-01T12:00:00Z"
    }
  ]
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.useaira.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Body

application/json

An object containing an array of events to be ingested.

​
events
object[]
required

An array of events to be ingested. Each event represents an usage of a resource from a customer at a specific point in time.

Required array length: 1 - 1000 elements

Response

The request was successfully processed and the events were recorded. No content is returned.

The response is of type object.