OPENAPI / COMPONENTS / SCHEMAS

Capture a batch of events

BatchCaptureRequest

Submits multiple events in one request. The whole body must be below the default 20 MB limit; historical_migration is only for migrations. It writes upstream data, so Hub does not proxy it.

object3properties

api_keystringrequired

PostHog project token injected only from caller-local configuration.

batchBatchEventrequired

Events to capture; the whole request body must remain under the default 20 MB limit.

historical_migrationboolean

True for historical migrations; omit or set false for realtime events.