Segments

A Segment is a rule-based slice of your user base. An automation can reference a segment through the segments field of its data object; remote configurations and experiments are targeted with their own rules (segmentation_conditions), which cannot reference a segment. v4 separates user-defined segments (fully editable) from system segments (managed by Qonversion).

Key concepts

Rules — Conditions over user fields (identifiers, environment) and the app platform; see Condition shape.
System segments — Read-only, predefined segments (e.g., active subscribers, churned users).
Uses — Referenced by automations (deprecated). Remote configurations, experiments, no-code screens, scheduled reports, and exports do not take a segment.

Condition shape

Each condition has the same four fields:

Field	Type	Required	Description
`metric`	string	yes	Metric identifier. Common: `environment`, `client_uid`, `custom_uid`, `client_advertiser_id`, `renewable`, `target_platform`.
`comparator`	string	yes	One of `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `contains`, `not_contains`.
`value`	string	yes	String-encoded value compared against the metric (cast to the metric’s type server-side).
`negate`	boolean	no	If `true`, the single rule matches when the comparison is false. Defaults to `false`.

Rules are joined with logical AND — every condition must hold for a user to fall into the segment. PUT /segments/{segment_id} is a full replace: pass the complete condition set you want to keep, or [] to clear. Omit the field entirely to leave conditions untouched. Example create body:

{
  "name": "EU prod renewables",
  "conditions": [
    { "metric": "environment", "comparator": "eq", "value": "prod" },
    { "metric": "renewable",   "comparator": "eq", "value": "1"    }
  ]
}

Available endpoints

Method	Endpoint	Description	Status
GET	`/segments`	List segments	New
POST	`/segments`	Create a segment	New
GET	`/segments/system`	List system segments	New
DELETE	`/segments/{segment_id}`	Delete a segment	New
GET	`/segments/{segment_id}`	Get a segment	New
PUT	`/segments/{segment_id}`	Update a segment (full replace)	New

Authentication

All v4 endpoints require a Secret Key. See Authentication.

Start here

Resource guides

REST API v4

Analytics API

Legacy: API v3

Key concepts

Condition shape

Available endpoints

Authentication

​Key concepts

​Condition shape

​Available endpoints

​Authentication

Key concepts

Condition shape

Available endpoints

Authentication