listSessionsAsync( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Start an async job to retrieve a list of session IDs, given the provided filters. The following filters must be passed:

  • Time period, either predefined or custom.
  • Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.
Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Session Recording Analytics - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsListSessionsAsyncOptions

Filter options. The following filters must be passed:

  • Time period, either predefined or custom.

  • Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.

Returns
Return Type:Promise<ListSessionsAsyncResponse>
Did this help?