keen/collections/keen-event-collection-api.opencollection.json at main · api-evangelist/keen · 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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
{
  "opencollection": "1.0.0",
  "info": {
    "name": "Keen Event Collection API",
    "version": "3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Collections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Keen Inspect collection schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.keen.io/3.0/projects/:projectId/events/:eventCollection",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "Keen project identifier."
              },
              {
                "name": "eventCollection",
                "value": "",
                "type": "path",
                "description": "Name of the event collection."
              }
            ]
          },
          "docs": "Returns the inferred schema of an event collection, including the names and inferred types of properties seen in events that have been recorded. Requires a Master Key."
        },
        {
          "info": {
            "name": "Keen List event collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.keen.io/3.0/projects/:projectId/events",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "Keen project identifier."
              }
            ]
          },
          "docs": "Returns a list of event collections defined in the project along with metadata about each collection. Requires a Master Key."
        },
        {
          "info": {
            "name": "Keen Inspect property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.keen.io/3.0/projects/:projectId/events/:eventCollection/properties/:propertyName",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "Keen project identifier."
              },
              {
                "name": "eventCollection",
                "value": "",
                "type": "path",
                "description": "Name of the event collection."
              },
              {
                "name": "propertyName",
                "value": "",
                "type": "path",
                "description": "Name of the event property to inspect."
              }
            ]
          },
          "docs": "Returns metadata about a single property in an event collection, such as the inferred data type. Requires a Master Key."
        }
      ]
    },
    {
      "info": {
        "name": "Events",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Keen Record a single event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.keen.io/3.0/projects/:projectId/events/:eventCollection",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "Keen project identifier."
              },
              {
                "name": "eventCollection",
                "value": "",
                "type": "path",
                "description": "Name of the event collection."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Records a single event in the specified event collection for the given Keen project. The request body is an arbitrary JSON object whose properties become event properties. Requires a Write Key with permission to record events into the project."
        },
        {
          "info": {
            "name": "Keen Record multiple events",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.keen.io/3.0/projects/:projectId/events",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "Keen project identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Records multiple events across one or more event collections in a single request. The body is a JSON object whose keys are event collection names and whose values are arrays of event objects. Requires a Write Key with permission to record events."
        }
      ]
    }
  ],
  "bundled": true
}