Track an event

This endpoint creates a new event for a user, persisting the event in Permutive for downstream consumption, such as for segmentation, insights, or routing to a data lake. It validates the event against the schema defined in your workspace, and generates an event ID for the event and optionally enriches the event with geo, ISP, and contextual data.

enrichboolean

This boolean parameter determines whether to enrich the event with geo, ISP, and natural language processing data. By default, this is set to true.

sdkpboolean

This boolean parameter is used to describe whether the event originated from a Permutive SDK on a client's device, where true denotes the event was from an SDK and false denotes an out-of-SDK event.

By default, this parameter is set to true. If you are interacting with this endpoint directly, rather than through a Permutive SDK, please set this parameter to false.

Request body

user_idstring uuid

The Permutive user ID of the user that the event belongs to.

If you do not provide a user ID, you must provide a non-empty list of aliases in the aliases field.

namestring required

The name of the event collection this event belongs to. The name is case-insensitive and must only contain characters in [a-zA-Z0-9_].

view_idstring uuid

The identifier for the view in which the event is taking place. This is used to group events within a single page or screen view.

session_idstring uuid

The identifier for the session in which the event is taking place. This is used to group events within a user session.

segmentsinteger[]

The list of segment codes that the user belonged to at the time of the event.

cohortsstring[]

The list of cohort IDs that the user belonged to at the time of the event.

propertiesobject

The properties that belong to this event. These properties must adhere to the specific schema configured for this event collection.

Response

Event created successfully

OR

v1

Track an event

Query parameters

Request body

Response