Skip to content

JourneyDateRangeKpiResponse

Source code in docs_src/capo_pinpoint/types/journey_date_range_kpi_response.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class JourneyDateRangeKpiResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application that the metric applies to.</p>"""
    end_time: NotRequired["capo_pinpoint.types.__timestamp_iso8601.__timestampIso8601"]
    """<p>The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.</p>"""
    journey_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the journey that the metric applies to.</p>"""
    kpi_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>"""
    kpi_result: NotRequired["capo_pinpoint.types.base_kpi_result.BaseKpiResult"]
    """<p>An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.</p>"""
    next_token: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.</p>"""
    start_time: NotRequired[
        "capo_pinpoint.types.__timestamp_iso8601.__timestampIso8601"
    ]
    """<p>The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.</p>"""

application_id instance-attribute 

application_id: NotRequired[__string]

The unique identifier for the application that the metric applies to.

end_time instance-attribute 

end_time: NotRequired[__timestampIso8601]

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

journey_id instance-attribute 

journey_id: NotRequired[__string]

The unique identifier for the journey that the metric applies to.

kpi_name instance-attribute 

kpi_name: NotRequired[__string]

The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

kpi_result instance-attribute 

kpi_result: NotRequired[BaseKpiResult]

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

next_token instance-attribute 

next_token: NotRequired[__string]

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

start_time instance-attribute 

start_time: NotRequired[__timestampIso8601]

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.