v1

latestOpenAPI 3.1.02026-07-2419603.1 MB

Tracker

Debugger

Get stream of sessions

get/api/tracker/v1/debugger

Query parameters

app_idstring uuid required

Example:d898ae47-61cd-4c9d-9d67-e5a930eb9f38

An application UUID for which sessions are requested

limitinteger

Example:20

Limit of fetched sessions (default value: 100). Number of returned sessions can exceed the limit, because session splitting by user ID happens after querying the database for the given limit

offsetinteger

Example:100

Fetched sessions offset. When using pagination, always query based on limit value, not on the count of sessions returned by previous query.

ipstring ip

Example:74.12.12.86

IP address from which event originated

visitor_idstring

Example:288f90221c221f81

Visitor ID of the user. Sessions returned can contain different visitor IDs due to user splitting happening after database query, which can assign user ID of the new created session to visitor ID.

user_idstring

Example:john@doe.com

User ID dimension of the user

page_urlstring

Example:blog

Filters out sessions that don't contain at least one event with URL matching the specified string.

event_type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

Example:1

Filters out sessions that don't contain at least one event of the specified type. The allowed values are:

1 # page view
2 # outlink
3 # download
4 # search
5 # custom event
6 # content impression
7 # content interaction
8 # goal conversion
9 # ecommerce conversion
11 # sharepoint
12 # consent form impression
13 # consent form click
14 # consent decision
15 # custom ping
16 # cart update
17 # broken event
18 # excluded event
19 # heartbeat
20 # deanonymization
21 # page performance
22 # product detail view
23 # add to cart
24 # remove from cart

lookup_windowinteger

Example:90

Describes how much back in time sessions shall be fetched, takes value in minutes

Response

A stream of sessions matching given criteria