Skip to content

SegmentDimensions

Source code in docs_src/capo_pinpoint/types/segment_dimensions.py
class SegmentDimensions(TypedDict, closed=True):
    attributes: NotRequired[
        "capo_pinpoint.types.map_of_attribute_dimension.MapOfAttributeDimension"
    ]
    """<p>One or more custom attributes to use as criteria for the segment.</p>"""
    behavior: NotRequired["capo_pinpoint.types.segment_behaviors.SegmentBehaviors"]
    """<p>The behavior-based criteria, such as how recently users have used your app, for the segment.</p>"""
    demographic: NotRequired[
        "capo_pinpoint.types.segment_demographics.SegmentDemographics"
    ]
    """<p>The demographic-based criteria, such as device platform, for the segment.</p>"""
    location: NotRequired["capo_pinpoint.types.segment_location.SegmentLocation"]
    """<p>The location-based criteria, such as region or GPS coordinates, for the segment.</p>"""
    metrics: NotRequired[
        "capo_pinpoint.types.map_of_metric_dimension.MapOfMetricDimension"
    ]
    """<p>One or more custom metrics to use as criteria for the segment.</p>"""
    user_attributes: NotRequired[
        "capo_pinpoint.types.map_of_attribute_dimension.MapOfAttributeDimension"
    ]
    """<p>One or more custom user attributes to use as criteria for the segment.</p>"""

attributes instance-attribute

attributes: NotRequired[MapOfAttributeDimension]

One or more custom attributes to use as criteria for the segment.

behavior instance-attribute

behavior: NotRequired[SegmentBehaviors]

The behavior-based criteria, such as how recently users have used your app, for the segment.

demographic instance-attribute

demographic: NotRequired[SegmentDemographics]

The demographic-based criteria, such as device platform, for the segment.

location instance-attribute

location: NotRequired[SegmentLocation]

The location-based criteria, such as region or GPS coordinates, for the segment.

metrics instance-attribute

metrics: NotRequired[MapOfMetricDimension]

One or more custom metrics to use as criteria for the segment.

user_attributes instance-attribute

user_attributes: NotRequired[MapOfAttributeDimension]

One or more custom user attributes to use as criteria for the segment.