Amazon Pinpoint · Schema
ApplicationDateRangeKpiResponse
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.
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics
Properties
| Name | Type | Description |
|---|---|---|
| ApplicationId | object | |
| EndTime | object | |
| KpiName | object | |
| KpiResult | object | |
| NextToken | object | |
| StartTime | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-application-date-range-kpi-response-schema.json",
"title": "ApplicationDateRangeKpiResponse",
"description": "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.",
"type": "object",
"properties": {
"ApplicationId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The unique identifier for the application that the metric applies to."
}
]
},
"EndTime": {
"allOf": [
{
"$ref": "#/components/schemas/__timestampIso8601"
},
{
"description": "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": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, 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 <a href=\"https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html\">Amazon Pinpoint Developer Guide</a>."
}
]
},
"KpiResult": {
"allOf": [
{
"$ref": "#/components/schemas/BaseKpiResult"
},
{
"description": "An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "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": {
"allOf": [
{
"$ref": "#/components/schemas/__timestampIso8601"
},
{
"description": "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."
}
]
}
},
"required": [
"KpiResult",
"KpiName",
"EndTime",
"StartTime",
"ApplicationId"
]
}