Skip to main content

Get all segments​

Get list of all segments

Query Parameters
  • paramsIO object required
  • optionalFields string[]
Responses

OK

Schema
  • Array [
  • audienceTracking boolean

    Segment is used in audience

  • audienceTrackingEditable boolean

    This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking can't be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.

  • conditionsData object required

    Conditions by which visitors will be segmented

  • firstLevel object[]

    First level conditions. Every level can have many conditions inside. E.g. we have 'firstLevelOrOperators' = [true], 'firstLevel'=[{OrOperators:[false], conditions: [SKY_STATUS, DAY_NIGHT]}, {OrOperators:[true], conditions: [PAGE_TITLE, NEW_VISITORS]}]. Then the expression will look like (SKY_STATUS AND DAY_NIGHT) OR (PAGE_TITLE OR NEW_VISITORS)

  • Array [
  • conditions object[]

    Add conditions (see TargetingConditionIO) to define a segment. The more conditions you add, the more precise your segment will be.

  • Array [
  • oneOf
  • htmlDescription string

    Html readable description of the targeting condition

  • id int64

    Unique identifier

  • weight int32 required

    More important conditions have greater values. Default value: 1

  • count int32

    Count of time elapsed since session became active according to the 'unitOfTime' field

  • include boolean

    Should visitors who match to the condition be included to or excluded from the segment. Default value: 'true'

  • matchType string

    Possible values: [EQUAL, LOWER, GREATER]

    How to match the specified amount of time

  • unitOfTime string

    Possible values: [SECOND, MINUTE, HOUR, DAY]

    What unit of measurements will be used to define if sessions are active for the required duration

  • ]
  • orOperators boolean[]

    Array of booleans ("or"=true, "and"=false) for binding conditions of second level.

  • ]
  • firstLevelOrOperators boolean[]

    Array of booleans ("or"=true, "and"=false) for binding firstLevel outer conditions.

  • createdBy int64

    Account id to whom created this segment

  • dateCreated date-time
  • dateModified date-time
  • description string

    Description of segment

  • experimentAmount int64

    Number of experiments using this segment. This is an optional field needs to specify in request params.

  • experiments int64[]

    List of experiment ids using this segment. This is an optional field needs to specify in request params.

  • featureFlagAmount int64

    Number of feature flags using this goal. This is an optional field needs to specify in request params.

  • hasSegmentCondition boolean

    Indicates whether the segment has condition SEGMENT

  • id int64

    Unique identifier of segment

  • isFavorite boolean

    Indicates whether the segment is considered as favorite.

  • name string required

    Name of segment

  • personalizationAmount int64

    Number of personalizations using this segment. This is an optional field needs to specify in request params.

  • personalizations int64[]

    List of personalization ids using this segment. This is an optional field needs to specify in request params.

  • segmentType string required

    Possible values: [STANDARD, KEY_MOMENT, FEATURE_FLAG, ALL]

    Segment type refers to the classification of segments based on their usage.

  • siteId int64 required

    Unique identifier of site for which the segment is going to be or was created

  • tags string[]
  • usedBySegmentCondition boolean

    Indicates whether the segment used by condition SEGMENT in other segments

  • ]
    • Loading...