Skip to main content
Every report reads one table of events. Each event has a type, a few IDs, a context object and a properties object.

Event types

Billing providers add their own event types, such as paid invoices and refunds. See Revenue.

Sources

channel is the event origin. It is not the acquisition channel (channel_type), such as Paid Search. See common fields.

Example

The SDKs fill in the envelope for you. The collector then adds the derived fields: country, device, OS, browser and channel_type. See common fields.

Rules for all events

  • A batch has 1 to 50 web or app events, or 1 to 100 server events. A batch cannot mix server events with web or app events.
  • message_id is a UUID. Reports count each message_id once. See idempotency.
  • properties is a flat object. Values are strings (at most 1024 characters), numbers, booleans or null. Nested objects and arrays are refused.
  • Unknown top-level fields are refused.
  • Event names have at most 128 characters. Use snake_case names, such as signup_completed.