This repository was archived by the owner on Jan 30, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathsessions.yaml
111 lines (109 loc) · 3.81 KB
/
sessions.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
post:
tags:
- Raw data
summary:
Fetch sessions
description: |
API that allows fetching raw sessions from the database (event-level data
is not available in this API). Please note that each request must be
authenticated.
#### Compression
When requesting large amount of data, make sure to include
an **Accept-Encoding: gzip** header to enable
compression.
requestBody:
required: true
content:
application/json:
schema:
$ref: '../index.yaml#/components/schemas/RawDataRequest'
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: Rows with results for the query.
items:
type: object
meta:
type: object
description: Additional results metadata for the query.
properties:
columns:
type: array
description: List of column IDs returned.
items:
type: string
count:
type: integer
description: Total number of results available for this query.
example: { "data": [ [ "2132601","2ecf33167d400648","2018-12-03T00:21:03","375x667",[ 1,"Smartphone" ] ] ],"meta": { "columns": [ "session_id","visitor_id","timestamp","resolution","device_type" ],"count": 1999 } }
400:
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
description: HTTP status code for the error.
detail:
type: string
description: Additional information about the error.
source:
type: object
description: Source of the error (if available).
properties:
parameter:
type: string
description: Path to the parameter that caused the error.
example: { "errors": [ { "status": "400", "detail": "Dimension \"example\" does not exist.", "source": { "parameter": "columns.column_id" } } ] }
401:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
description: HTTP status code for the error.
detail:
type: string
description: Additional information about the error.
example: { "errors": [ { "status": "401", "detail": "No valid credentials provided." } ] }
403:
description: Forbidden
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
status:
type: string
description: HTTP status code for the error.
detail:
type: string
description: Additional information about the error.
example: { "errors": [ { "status": "403", "detail": "No valid license found." } ] }