API reference / Sessions
List session replays
The session replays that Troopy recorded in the period, newest first: of one visitor, or of the visits that viewed one page. The site records them when replays is on (PATCH /session-settings). A replay is one tab of a visit. Each replay has its pages, clicks and length. Its events are at eventsUrl, as JSON lines, with the same key. Troopy keeps a replay for 30 days.
/api/v1/session-replaysOther ways to call it
troopy sessions replaystroopy_list_session_replaysQuery parameters
periodenum<string>now is the last 10 minutes. 7d and 30d end today. 3m, 6m and 12m are whole months that end with this month. week starts on Monday. custom needs from and to
nowtodayyesterday24h7d30d3m6m12mweekmonthyearallcustom
Default "30d"
fromstringYYYY-MM-DD, in the workspace's time zone
date
tostringYYYY-MM-DD. The period includes this day
date
visitorstringThe visitor's id, as the script or SDK sent it
pathstringOnly the visits that viewed this page, such as /pricing
At most 500 characters
pageinteger1-based page number
Default 1 · At least 1
limitintegerDefault 20 · At least 1 · At most 100
Response
200 · application/jsondata*array<object>10 properties
id*stringThe id of the replay: one tab of a visit, as the session, a dash and the id of the tab
visitor*stringstart*stringISO 8601 date and time
duration*integerSeconds
pages*array<string>clicks*integercountry*string | nulldevice*string | nullbrowser*string | nulleventsUrl*stringpagination*object4 properties
page*integerlimit*integertotal*integerpages*integer