2019/07/24 - Amazon Pinpoint - 2 new api methods
Changes This release adds support for programmatic access to many of the same campaign metrics that are displayed on the Amazon Pinpoint console. You can now use the Amazon Pinpoint API to monitor and assess performance data for campaigns, and integrate metrics data with other reporting tools. We update the metrics data continuously, resulting in a data latency timeframe that is limited to approximately two hours.
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
See also: AWS API Documentation
Request Syntax
client.get_application_date_range_kpi(
ApplicationId='string',
EndTime=datetime(2015, 1, 1),
KpiName='string',
NextToken='string',
PageSize='string',
StartTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
datetime
The last date to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in ISO 8601 format, for example: 2019-07-19 for July 19, 2019. To define a date range that ends at a specific time, specify the date and time in ISO 8601 format, for example: 2019-07-19T20:00Z for 8:00 PM July 19, 2019.
string
[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 attempted-deliveries and successful-deliveries. For a list of valid values, see the Amazon Pinpoint Developer Guide .
string
The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the App Metrics and Campaign Metrics resources.
string
The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the App Metrics and Campaign Metrics resources.
datetime
The first date to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in ISO 8601 format, for example: 2019-07-15 for July 15, 2019. To define a date range that begins at a specific time, specify the date and time in ISO 8601 format, for example: 2019-07-15T16:00Z for 4:00 PM July 15, 2019.
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 or date and time of the date range that was used to filter the query results, in 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 (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 or campaign.
(dict) --
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.
(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 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.
(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 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 App Metrics resource. The App Metrics resource returns all results in a single page.
StartTime (datetime) --
The first date or date and time of the date range that was used to filter the query results, in ISO 8601 format. The date range is inclusive.
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
See also: AWS API Documentation
Request Syntax
client.get_campaign_date_range_kpi(
ApplicationId='string',
CampaignId='string',
EndTime=datetime(2015, 1, 1),
KpiName='string',
NextToken='string',
PageSize='string',
StartTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
string
[REQUIRED]
The unique identifier for the campaign.
datetime
The last date to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in ISO 8601 format, for example: 2019-07-19 for July 19, 2019. To define a date range that ends at a specific time, specify the date and time in ISO 8601 format, for example: 2019-07-19T20:00Z for 8:00 PM July 19, 2019.
string
[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 attempted-deliveries and successful-deliveries. For a list of valid values, see the Amazon Pinpoint Developer Guide .
string
The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the App Metrics and Campaign Metrics resources.
string
The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the App Metrics and Campaign Metrics resources.
datetime
The first date to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in ISO 8601 format, for example: 2019-07-15 for July 15, 2019. To define a date range that begins at a specific time, specify the date and time in ISO 8601 format, for example: 2019-07-15T16:00Z for 4:00 PM July 15, 2019.
dict
Response Syntax
{
'CampaignDateRangeKpiResponse': {
'ApplicationId': 'string',
'CampaignId': '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.
CampaignDateRangeKpiResponse (dict) --
Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.
ApplicationId (string) --
The unique identifier for the application that the metric applies to.
CampaignId (string) --
The unique identifier for the campaign that the metric applies to.
EndTime (datetime) --
The last date or date and time of the date range that was used to filter the query results, in 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 (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 or campaign.
(dict) --
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.
(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 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.
(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 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 Campaign Metrics resource. The Campaign Metrics resource returns all results in a single page.
StartTime (datetime) --
The first date or date and time of the date range that was used to filter the query results, in ISO 8601 format. The date range is inclusive.