Ingest a batch of events

Send 1–100 events. Ordering is guaranteed per customer, not across customers.

POST /v1/events/batch

Ingest a batch of customer events

cURL

curl --request POST \
  --url https://api.swapnice.com/v1/events/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "events": [
    {
      "customer_id": "<string>",
      "client_event_id": "<string>",
      "event_type": "purchase.completed",
      "ontology": "ygo",
      "occurred_at": "2023-11-07T05:31:56Z",
      "payload": {},
      "object": "sku_blue_eyes_tin",
      "consent_receipt_id": "<string>",
      "context": {},
      "confidence": 1
    }
  ]
}
'

202

{
  "batch_id": "<string>",
  "status": "accepted",
  "accepted_count": 123,
  "rejected_count": 123,
  "items": [
    {
      "client_event_id": "<string>",
      "status": "accepted",
      "event_id": "<string>",
      "error": {
        "code": "<string>",
        "message": "<string>",
        "field": "<string>"
      }
    }
  ]
}

Send 1–100 events. Ordering is guaranteed per customer, not across customers.

Each item uses the same shape as a single ingest. Partial acceptance is possible.

Authorizations

Authorization · string · header · required

OAuth 2.1 authorization code with PKCE. Implicit and password flows are unsupported.

Headers

Idempotency-Key · string · required

Required for mutating requests. Replays with the same key and payload hash return the original logical result; replays with a different payload hash return 409.

Required string length: 16 - 255

Body

application/json

events · object[] · required

Required array length: 1 - 100 elements

Show child attributes

Response

202

application/json

Batch accepted for processing.

batch_id · string · required

status · enum<string> · required

Available options: accepted, partially_accepted

accepted_count · integer · required

rejected_count · integer · required

items · object[] · required

Show child attributes