POST

List Sessions Async


Start an async job to retrieve a list of session IDs, given the specified 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

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Session Recording Analytics - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/analytics/v1/sessions/list/async

Body Params
timezonestringmaxLength 100

User's timezone. Defaults to timezone as set in the Site Properties API.


ONE OF:

customTimePeriodCustomTimePeriod

Custom time period with start & end dates.


predefinedTimePeriodstring

Predefined time period.


ONE OF:

navigationFlowNavigationFlow

Navigation flow details.


conversionFunnelConversionFunnel

Conversion funnel details. The steps in the journey the visitor has taken on the site.


deviceTypeDeviceType

Device type.

Response Object
jobIdstringformat GUID

List sessions job ID. Pass this ID to Get List Sessions Job Result to retrieve job details and metadata.

List Sessions Async
Request
cURL
curl -X POST \ 'https://www.wixapis.com/analytics/v1/sessions/list/async' \ -H 'Content-type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "deviceType": { "type": "MOBILE" }, "predefinedTimePeriod": "LAST_30_DAYS" }'
Response
JSON
{ "jobId": "a391a44f-b037-4344-b555-6f5be67c4123" }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?