Skip to main content
GET
List recorded sessions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string

YYYY-MM-DD (UTC) or an ISO 8601 instant. Send both dates or neither. Without them the range is the last 7 days. The range is 31 days at most.

end_date
string

YYYY-MM-DD (UTC, inclusive) or an ISO 8601 instant.

source
string

Case-insensitive exact match, such as facebook.

medium
string

Case-insensitive exact match.

campaign
string

Case-insensitive exact match.

device_type
string

Case-insensitive exact match, such as mobile or desktop.

in_app_browser
enum<string>

other is any other in-app browser, such as Snapchat or Pinterest. none is a regular browser.

Available options:
instagram,
facebook,
tiktok,
other,
none
page_type_entry
string

The landing page type, such as home, collection, product, cart, search, content, or account. Case-insensitive.

flags
string

Comma-separated. A session matches only when every listed flag is set. rage_clicks, dead_clicks, and errors match a count above zero. no_checkout matches sessions that added to cart but never started checkout. Allowed: rage_clicks, dead_clicks, errors, error_click, error_before_exit, error_before_checkout, abandoned_form, reached_product, reached_cart, add_to_cart, checkout_started, purchased, quick_back, excessive_scroll, bounced, no_final_flush, no_checkout.

Example:

"rage_clicks,reached_cart,no_checkout"

limit
integer
default:20
Required range: 1 <= x <= 50
cursor
string

The next_cursor of the previous page.

Response

Successful response.

sessions
object[]
truncated
boolean

true when more sessions matched than this page holds.

next_cursor
string

Present only when truncated is true. Pass it as cursor.