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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) 


9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 9862

class JourneyDateRangeKpiResponse < Struct.new(
  :application_id,
  :end_time,
  :journey_id,
  :kpi_name,
  :kpi_result,
  :next_token,
  :start_time)
  include Aws::Structure
end

#end_time ⇒ Time

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.

Returns:

  • (Time) 


9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 9862

class JourneyDateRangeKpiResponse < Struct.new(
  :application_id,
  :end_time,
  :journey_id,
  :kpi_name,
  :kpi_result,
  :next_token,
  :start_time)
  include Aws::Structure
end

#journey_id ⇒ String

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

Returns:

  • (String) 


9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 9862

class JourneyDateRangeKpiResponse < Struct.new(
  :application_id,
  :end_time,
  :journey_id,
  :kpi_name,
  :kpi_result,
  :next_token,
  :start_time)
  include Aws::Structure
end

#kpi_name ⇒ 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].

[1]: docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html

Returns:

  • (String) 


9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 9862

class JourneyDateRangeKpiResponse < Struct.new(
  :application_id,
  :end_time,
  :journey_id,
  :kpi_name,
  :kpi_result,
  :next_token,
  :start_time)
  include Aws::Structure
end

#kpi_result ⇒ Types::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:



9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 9862

class JourneyDateRangeKpiResponse < Struct.new(
  :application_id,
  :end_time,
  :journey_id,
  :kpi_name,
  :kpi_result,
  :next_token,
  :start_time)
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

  • (String) 


9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 9862

class JourneyDateRangeKpiResponse < Struct.new(
  :application_id,
  :end_time,
  :journey_id,
  :kpi_name,
  :kpi_result,
  :next_token,
  :start_time)
  include Aws::Structure
end

#start_time ⇒ Time

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.

Returns:

  • (Time) 


9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 9862

class JourneyDateRangeKpiResponse < Struct.new(
  :application_id,
  :end_time,
  :journey_id,
  :kpi_name,
  :kpi_result,
  :next_token,
  :start_time)
  include Aws::Structure
end