Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

get-application-date-range-kpi

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-application-date-range-kpi
--application-id <value>
[--end-time <value>]
--kpi-name <value>
[--next-token <value>]
[--page-size <value>]
[--start-time <value>]
[--cli-input-json <value>]
[--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.

--end-time (timestamp)

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, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.

--kpi-name (string)

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 .

--next-token (string)

The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.

--page-size (string)

The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.

--start-time (timestamp)

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, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

ApplicationDateRangeKpiResponse -> (structure)

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

ApplicationId -> (string)

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

EndTime -> (timestamp)

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.

KpiName -> (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 valid values, see the Amazon Pinpoint Developer Guide .

KpiResult -> (structure)

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

Rows -> (list)

An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application or campaign.

(structure)

Provides the results of a query that retrieved the data for a standard metric that applies to an application or campaign.

GroupedBys -> (list)

An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

(structure)

Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application or campaign.

Key -> (string)

The name of the field that Amazon Pinpoint uses to store the value specified by the Value property.

Type -> (string)

The data type of the value specified by the Value property.

Value -> (string)

In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

Values -> (list)

An array of objects that provides pre-aggregated values for a standard metric that applies to an application or campaign.

(structure)

Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application or campaign.

Key -> (string)

The name of the field that Amazon Pinpoint uses to store the value specified by the Value property.

Type -> (string)

The data type of the value specified by the Value property.

Value -> (string)

In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

NextToken -> (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 Application Metrics resource. The Application Metrics resource returns all results in a single page.

StartTime -> (timestamp)

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.