Ingest events

POST

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"
    }
  ]
}
'

{}

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

Show child attributes

events.idempotencyKey

string

required

Unique key to ensure idempotency of the event. This key is used to prevent duplicate events from being recorded.

Example:

"123e4567-e89b-12d3-a456-426614174000"

events.eventName

string

required

Identifier of the event. Used on the resource definition.

Example:

"api_request"

events.customerExternalId

string

required

External identifier of the customer involved in the event.

Example:

"cust_1234567890abcdef"

events.properties

object

required

A dictionary of additional properties associated with the event.

Show child attributes

events.properties.value

number

required

Required range: x >= 0

Example:

3600

events.properties.{key}

Example:

{
  "value": 3600,
  "endpoint": "/api/v1/users",
  "method": "GET",
  "status_code": 200
}

events.occurredAt

string<date-time>

required

ISO 8601 timestamp in UTC (no timezone offset) indicating when the event occurred.

Example:

"2024-01-01T12:00:00Z"

Response

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

List invoicesThis endpoint allows fetching a list of invoices based on customerId, customerExternalId, invoiceStartDateFrom, invoiceStartDateTo, invoiceEndDateFrom, invoiceEndDateTo, limit, and offset. The response will include a list of invoices that match the provided filters. Supports pagination through limit and offset parameters. It also returns, if available, a `pix` and `bank_slip` URL for each invoice, which expires after 15 minutes.

⌘I

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"
    }
  ]
}
'

{}

Conheça a Aira

Conceitos Essenciais

Referência da API

Ingest events

Authorizations

Body

Response