You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::JourneyDateRangeKpiResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)

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

#end_timeTime

Returns:

  • (Time)

#journey_idString

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

Returns:

  • (String)

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

#kpi_nameString

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.

Returns:

  • (String)

    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for.

#kpi_resultTypes::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.

Returns:

#next_tokenString

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.

Returns:

  • (String)

    The string to use in a subsequent request to get the next page of results in a paginated response.

#start_timeTime

Returns:

  • (Time)