Pinpoint.Client.get_application_date_range_kpi(**kwargs)¶Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
See also: AWS API Documentation
Request Syntax
response = client.get_application_date_range_kpi(
ApplicationId='string',
EndTime=datetime(2015, 1, 1),
KpiName='string',
NextToken='string',
PageSize='string',
StartTime=datetime(2015, 1, 1)
)
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
[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.
dict
Response Syntax
{
'ApplicationDateRangeKpiResponse': {
'ApplicationId': 'string',
'EndTime': datetime(2015, 1, 1),
'KpiName': 'string',
'KpiResult': {
'Rows': [
{
'GroupedBys': [
{
'Key': 'string',
'Type': 'string',
'Value': 'string'
},
],
'Values': [
{
'Key': 'string',
'Type': 'string',
'Value': 'string'
},
]
},
]
},
'NextToken': 'string',
'StartTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
The request succeeded.
ApplicationDateRangeKpiResponse (dict) --
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 (datetime) --
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 possible values, see the Amazon Pinpoint Developer Guide.
KpiResult (dict) --
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, campaign, or journey.
(dict) --
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
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.
(dict) --
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, campaign, or journey.
Key (string) --
The friendly name of the metric whose value is 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, campaign, or journey.
(dict) --
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, campaign, or journey.
Key (string) --
The friendly name of the metric whose value is 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 because the resource returns all results in a single page.
StartTime (datetime) --
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.
Exceptions
Pinpoint.Client.exceptions.BadRequestExceptionPinpoint.Client.exceptions.InternalServerErrorExceptionPinpoint.Client.exceptions.PayloadTooLargeExceptionPinpoint.Client.exceptions.ForbiddenExceptionPinpoint.Client.exceptions.NotFoundExceptionPinpoint.Client.exceptions.MethodNotAllowedExceptionPinpoint.Client.exceptions.TooManyRequestsException