Get Journey Run Execution Activity Metrics

pinpoint_get_journey_run_execution_activity_metrics

R Documentation

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity¶

Description¶

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

Usage¶

pinpoint_get_journey_run_execution_activity_metrics(ApplicationId,
  JourneyActivityId, JourneyId, NextToken, PageSize, RunId)

Arguments¶

ApplicationId: [required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
JourneyActivityId: [required] The unique identifier for the journey activity.
JourneyId: [required] The unique identifier for the journey.
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.
RunId: [required] The unique identifier for the journey run.

Value¶

A list with the following syntax:

list(
  JourneyRunExecutionActivityMetricsResponse = list(
    ActivityType = "string",
    ApplicationId = "string",
    JourneyActivityId = "string",
    JourneyId = "string",
    LastEvaluatedTime = "string",
    Metrics = list(
      "string"
    ),
    RunId = "string"
  )
)

Request syntax¶

svc$get_journey_run_execution_activity_metrics(
  ApplicationId = "string",
  JourneyActivityId = "string",
  JourneyId = "string",
  NextToken = "string",
  PageSize = "string",
  RunId = "string"
)

Examples¶

## Not run: 
# The following example gets activity execution metrics for a single run
# of a journey.
svc$get_journey_run_execution_activity_metrics(
  ApplicationId = "11111111112222222222333333333344",
  JourneyId = "aaaaaaaaaabbbbbbbbbbccccccccccdd",
  RunId = "99999999998888888888777777777766",
  JourneyActivityId = "AAAAAAAAAA"
)

## End(Not run)