listSessionsAsync( )

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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Session Recording Analytics - all permissions
Learn more about app permissions.
Method Declaration
Copy
function listSessionsAsync(
  options: ListSessionsAsyncOptions,
): Promise<ListSessionsAsyncResponse>;
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>
JavaScript
import { analyticsSession } from "@wix/analytics-session";

async function listSessionsAsync(options) {
  const response = await analyticsSession.listSessionsAsync(options);
}
Errors

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

Did this help?