amazon-pinpoint/json-schema/amazon-pinpoint-campaign-date-range-kpi-response-schema.json at main · api-evangelist/amazon-pinpoint · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
  "$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-campaign-date-range-kpi-response-schema.json",
  "title": "CampaignDateRangeKpiResponse",
  "description": "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.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application that the metric applies to."
        }
      ]
    },
    "CampaignId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the campaign 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 Campaign 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",
    "CampaignId",
    "StartTime",
    "ApplicationId"
  ]
}