LiveEventBatch

Fields

A batch of events sent from a client machine. Batching amortises HTTP overhead — 50–1000 events per call is recommended.

4 fields

batch_id

string or null

Client-generated identity for this batch. The same value must be reused for every HTTP retry; omitted for legacy callers.

events · required

array of LiveEvent

run_id · required

string

session_id · required

string

Raw schema (JSON)

{
  "description": "A batch of events sent from a client machine.\nBatching amortises HTTP overhead — 50–1000 events per call is recommended.",
  "properties": {
    "batch_id": {
      "anyOf": [
        {
          "maxLength": 255,
          "minLength": 1,
          "pattern": "^[^\\x00-\\x1f\\x7f]+$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Client-generated identity for this batch. The same value must be reused for every HTTP retry; omitted for legacy callers.",
      "title": "Batch Id"
    },
    "events": {
      "items": {
        "$ref": "#/components/schemas/LiveEvent"
      },
      "maxItems": 1000,
      "minItems": 1,
      "title": "Events",
      "type": "array"
    },
    "run_id": {
      "maxLength": 100,
      "minLength": 1,
      "title": "Run Id",
      "type": "string"
    },
    "session_id": {
      "maxLength": 255,
      "minLength": 1,
      "title": "Session Id",
      "type": "string"
    }
  },
  "required": [
    "session_id",
    "run_id",
    "events"
  ],
  "title": "LiveEventBatch",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/stream/events/batch — Ingest Event Batch

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON