[ aws . pinpoint ]

get-journey-execution-metrics

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-journey-execution-metrics
--application-id <value>
--journey-id <value>
[--next-token <value>]
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

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

--journey-id (string)

The unique identifier for the journey.

--next-token (string)

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.

--page-size (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

JourneyExecutionMetricsResponse -> (structure)

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

ApplicationId -> (string)

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

JourneyId -> (string)

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

LastEvaluatedTime -> (string)

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

Metrics -> (map)

A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide .

key -> (string)

value -> (string)