/
OpenAPI-Ingest.yaml
148 lines (148 loc) · 3.79 KB
/
OpenAPI-Ingest.yaml
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
openapi: 3.0.3
info:
title: Serverless Website Analytics Ingest API
version: '-'
servers:
- url: '-'
paths:
/v1/page/view:
post:
operationId: mutation.pageView
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
site:
type: string
user_id:
type: string
session_id:
type: string
page_id:
type: string
page_url:
type: string
page_opened_at:
type: string
time_on_page:
type: number
utm_source:
type: string
utm_medium:
type: string
utm_campaign:
type: string
utm_term:
type: string
utm_content:
type: string
querystring:
type: string
referrer:
type: string
required:
- site
- user_id
- session_id
- page_id
- page_url
- page_opened_at
- time_on_page
additionalProperties: false
parameters: []
responses:
'200':
description: Successful response
content:
application/json:
schema: {}
default:
$ref: '#/components/responses/error'
/v1/event/track:
post:
operationId: mutation.eventTrack
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
site:
type: string
user_id:
type: string
session_id:
type: string
category:
type: string
event:
type: string
tracked_at:
type: string
data:
type: number
utm_source:
type: string
utm_medium:
type: string
utm_campaign:
type: string
utm_term:
type: string
utm_content:
type: string
querystring:
type: string
referrer:
type: string
required:
- site
- user_id
- session_id
- event
- tracked_at
additionalProperties: false
parameters: []
responses:
'200':
description: Successful response
content:
application/json:
schema: {}
default:
$ref: '#/components/responses/error'
components:
securitySchemes:
Authorization:
type: http
scheme: bearer
responses:
error:
description: Error response
content:
application/json:
schema:
type: object
properties:
message:
type: string
code:
type: string
issues:
type: array
items:
type: object
properties:
message:
type: string
required:
- message
additionalProperties: false
required:
- message
- code
additionalProperties: false