Skip to content

Range

Source code in docs_src/capo_customer_profiles/types/range.py
class Range(TypedDict, closed=True):
    value: "capo_customer_profiles.types.value.Value"
    """<p>The amount of time of the specified unit.</p>"""
    unit: "capo_customer_profiles.types.unit.Unit"
    """<p>The unit of time.</p>"""
    value_range: NotRequired["capo_customer_profiles.types.value_range.ValueRange"]
    """<p>A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.</p>"""
    timestamp_source: NotRequired[
        "capo_customer_profiles.types.string1_to255.string1To255"
    ]
    r"""<p>An expression specifying the field in your JSON object from which the date should be parsed. The expression should follow the structure of \"{ObjectTypeName.<Location of timestamp field in JSON pointer format>}\". E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "1737587945945"}}, then TimestampSource should be "{MyType.generatedAt.timestamp}".</p>"""
    timestamp_format: NotRequired[
        "capo_customer_profiles.types.string1_to255.string1To255"
    ]
    """<p>The format the timestamp field in your JSON object is specified. This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO_8601 (following ISO_8601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat should be "ISO_8601".</p>"""

timestamp_format instance-attribute

timestamp_format: NotRequired[string1To255]

The format the timestamp field in your JSON object is specified. This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO_8601 (following ISO_8601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat should be "ISO_8601".

timestamp_source instance-attribute

timestamp_source: NotRequired[string1To255]

An expression specifying the field in your JSON object from which the date should be parsed. The expression should follow the structure of \"{ObjectTypeName.}\". E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "1737587945945"}}, then TimestampSource should be "{MyType.generatedAt.timestamp}".

unit instance-attribute

unit: Unit

The unit of time.

value instance-attribute

value: Value

The amount of time of the specified unit.

value_range instance-attribute

value_range: NotRequired[ValueRange]

A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.