Discover Segments

In Discover, segments let you create data subsets so you can drill down into specific visitor activities and characteristics. The Discover API lets you include a segment definition when defining the metrics used in a Discover report definition (see <<tns:reportDescription>>). For sample Discover segment definitions, see <<Sample Code>>. Consider the following when creating a Discover segment:
  • A Discover segment can be recursive.
  • A Discover segment definition contains the following components.
    • Segment List: A list of the segments to include in the report.
    • Segment: Contains the segment detail. Each segment definition can contain at most one include segment and one exclude segment. The invert flag indicates if the segment is an include (invert = false) or exclude (invert = true) segment.
    • Type: Defines the segment type. Supported segment types include: visitor, visit, pageView, or event. Optionally, you can include the following components in the Segment type:
      • Events: An event that occurs during a visit. Events can be stand-alone elements of a segment definition, or contained within a Condition. Supported event values include: productView, clickThrough, shoppingCartRemove, shoppingCartAdd, checkout, shoppingCartView, shoppingCartOpen, order, revenue, units, singlePageVisits, evar#, and custom#.
      • Conditions: One or more restrictions for including data in the segment. Conditions are a non-recursive, hierarchical data type that can include the following components (For example: visitNumber > 2):
        • element: A particular data element that you want to test (for example, visitNumber).
        • values: A value that you want to use to test the associated element (for example, 2).
        • operator: The boolean operator to apply to the element/value pair. Supported operators include: =, !=, >, >=, <, <=, contains, not-contains, contains-all, not-contains-all, contains-any, not-contains-any.
For additional information about segments, see "Working with Segments" in the Discover User Guide at Help > Documentation.

Comments (0)

Must be logged in to comment. or register now to comment!