v1

latestOpenAPI 3.1.02026-07-262210674.8 KB
API version 1

Segment user based on provided events and pre-existing state

This endpoint accepts a list of events for a given user and combines them with any pre-existing state for the user to determine the full list of cohorts of which they are a member. State is also persisted, to be applied to subsequent requests for the same user.

Events provided to this endpoint are published to the Permutive Events API, meaning that they will be reflected in other areas of Permutive, for example Insights.

post/ccs/v1/segmentation

Query parameters

activationsboolean

Return a list of activated cohorts in the response

synchronous-validationboolean

Validate provided event(s) against their schema before proceeding with segmentation.

By default validation is performed asynchronously after segmentation has been performed and the response has been returned. This can make it difficult to debug issues with invalid events.

It is recommended to use this option only during development and debugging, as validation can be expensive and slow.

Request body

user_idstring uuid

Response

List of cohorts of which the user is currently a member, along with the Permutive User ID and activations if requested

user_idstring uuid required
cohortsstring[]
activationsMapSeqString
All 22 operations