Skip to content

Get Journey Date Range Kpi

pinpoint_get_journey_date_range_kpi R Documentation

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey

Description

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

Usage

pinpoint_get_journey_date_range_kpi(ApplicationId, EndTime, JourneyId,
  KpiName, NextToken, PageSize, StartTime)

Arguments

ApplicationId

[required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

EndTime

The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

JourneyId

[required] The unique identifier for the journey.

KpiName

[required] The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data 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. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

NextToken

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

PageSize

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

StartTime

The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

Value

A list with the following syntax: 

list(
  JourneyDateRangeKpiResponse = list(
    ApplicationId = "string",
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    JourneyId = "string",
    KpiName = "string",
    KpiResult = list(
      Rows = list(
        list(
          GroupedBys = list(
            list(
              Key = "string",
              Type = "string",
              Value = "string"
            )
          ),
          Values = list(
            list(
              Key = "string",
              Type = "string",
              Value = "string"
            )
          )
        )
      )
    ),
    NextToken = "string",
    StartTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$get_journey_date_range_kpi(
  ApplicationId = "string",
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  JourneyId = "string",
  KpiName = "string",
  NextToken = "string",
  PageSize = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  )
)