v1

latestOpenAPI 3.1.02026-07-22750642.5 KB

Segments

Get a segment

Get one segment by slug, with a live member count.

get/api/v1/segments/{slug}

slugstring required

The segment slug, as returned by segments_list.

Success

slugstring required

Unique identifier within your organization.

namestring required

descriptionstring nullable required

evaluationCadence'REACTIVE_ONLY' | 'HOURLY' | 'DAILY' required

How often the segment is re-evaluated. REACTIVE_ONLY segments only change when evaluated explicitly.

memberCountinteger required

Live count of currently active members.

lastEvaluatedAtstring nullable required

ISO 8601 timestamp; null if the segment has never evaluated.

createdAtstring required

ISO 8601 timestamp.