Segment tools - Claimr

A segment is a saved audience filter. Participants who match it get tagged with it, so you can slice a campaign by location, XP, completed tasks, and more. Segments use the Segments permission area.

Tool	What it does	Access
`claimr_get_segment_fields`	Lists the fields a segment can filter on, the operators each field allows, and the values each operator expects. For one field, it lists the accepted values, such as the country list for location.	Segments: read
`claimr_get_segments`	Lists the segments of a campaign.	Segments: read
`claimr_get_segment`	Gets one segment with all its conditions, by name or ID.	Segments: read
`claimr_create_segment`	Creates a segment.	Segments: write
`claimr_update_segment`	Changes a segment. Passing conditions replaces all of them.	Segments: write
`claimr_delete_segment`	Deletes a segment.	Segments: write

How conditions combine

Conditions are grouped. Each group combines its own conditions with all or any, and the segment combines its groups the same way. For example, “from Germany or France, and more than 100 XP” is two groups:

Location is Germany or location is France.
XP is more than 100.

The segment matches when all groups match.

When participants are tagged

Participants are tagged on their next recalculation, not right away. After you delete a segment, participants keep its tag until their next recalculation.

Segment tools work with filters, not people. The assistant can’t list the participants in a segment.