Skip to content

Record analytics events

POST
/api/v1/analytics/events

Accept a batch of analytics events (1-50). Authenticated.

Authorizations

Request Body required

Request body for batch event recording.

Attributes: events: List of analytics events (1-50).

object
events
required

Batch of events (1-50)

Array<object>
>= 1 items <= 50 items

A single analytics event in a batch.

Attributes: event_type: Type of event (page_view, feature_use, session_start, session_end). feature: Feature name (required for feature_use events). timestamp: Unix epoch timestamp of the event. metadata: Optional extra metadata. session_id: Session identifier (required for session_start/session_end).

object
event_type
required

Event type

string
>= 1 characters
feature
Any of:
string
metadata
Any of:
object
key
additional properties
any
session_id
Any of:
string
timestamp
required

Unix epoch timestamp

integer

Responses

202

Successful Response

object
key
additional properties
integer

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string