Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

jobId

string

Field options. The `limit` and `offset` filters **must** be passed.

options

GetListSessionsJobResultOptions

Retrieves the job status and a list of session IDs, if ready.

import { analyticsSession } from 'wix-analytics-session.v2';

async function getListSessionsJobResult(jobId, options) {
  try {
    const result = await analyticsSession.getListSessionsJobResult(jobId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getListSessionsJobResult example for dashboard page code

import { analyticsSession } from 'wix-analytics-session.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedGetListSessionsJobResult = elevate(analyticsSession.getListSessionsJobResult);

export const getListSessionsJobResult = webMethod(
  Permissions.Anyone,
  async (jobId, options) => {
    try {
      const result = await elevatedGetListSessionsJobResult(jobId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


getListSessionsJobResult example for exporting from backend code

getListSessionsJobResult

Manage Session Recording Analytics - all permissions

GetListSessionsJobResultResponse

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.

ListSessionsAsyncOptions

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.

import { analyticsSession } from 'wix-analytics-session.v2';

async function listSessionsAsync(options) {
  try {
    const result = await analyticsSession.listSessionsAsync(options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


listSessionsAsync example for dashboard page code

import { analyticsSession } from 'wix-analytics-session.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedListSessionsAsync = elevate(analyticsSession.listSessionsAsync);

export const listSessionsAsync = webMethod(
  Permissions.Anyone,
  async (options) => {
    try {
      const result = await elevatedListSessionsAsync(options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


listSessionsAsync example for exporting from backend code

listSessionsAsync

ListSessionsAsyncResponse

sessionIds

Marks browser session recordings as deleted.

import { analyticsSession } from 'wix-analytics-session.v2';

async function markRecordingsAsDeleted(sessionIds) {
  try {
    const result = await analyticsSession.markRecordingsAsDeleted(sessionIds);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


markRecordingsAsDeleted example for dashboard page code

import { analyticsSession } from 'wix-analytics-session.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedMarkRecordingsAsDeleted = elevate(analyticsSession.markRecordingsAsDeleted);

export const markRecordingsAsDeleted = webMethod(
  Permissions.Anyone,
  async (sessionIds) => {
    try {
      const result = await elevatedMarkRecordingsAsDeleted(sessionIds);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


markRecordingsAsDeleted example for exporting from backend code

markRecordingsAsDeleted

void

sessionId

import { analyticsSession } from 'wix-analytics-session.v2';

async function markSessionAsRecorded(sessionId) {
  try {
    const result = await analyticsSession.markSessionAsRecorded(sessionId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


markSessionAsRecorded example for dashboard page code

import { analyticsSession } from 'wix-analytics-session.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedMarkSessionAsRecorded = elevate(analyticsSession.markSessionAsRecorded);

export const markSessionAsRecorded = webMethod(
  Permissions.Anyone,
  async (sessionId) => {
    try {
      const result = await elevatedMarkSessionAsRecorded(sessionId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


markSessionAsRecorded example for exporting from backend code

markSessionAsRecorded

# About the Analytics Sessions API

The Analytics Sessions API enables developers to access session IDs collected from Wix sites. 

<blockquote class='important'>
 Beta Feature: 
 This functionality is currently available to select beta users only.
</blockquote>

A session is a visit of a visitor to a site. A session starts when a visitor reaches the site, and ends after 30 minutes of inactivity. Within each session, a visitor can take multiple actions and view multiple pages. Each session is identified using a [browser session ID](https://hazelcast.com/glossary/web-session).

Wix offers select beta users an entry point to access selected analytics apps that record visitor sessions. When a site user (admin or contributor) accesses the entry point, Wix passes all relevant filters appended to the iframe URL, and your app can use the filter data to request a list of relevant visitor sessions from Wix. With this API, your app can extend Wix analytics data to help site owners identify pain points and find areas for improvement.

## Before you begin
- This functionality is currently available to select beta users only. If you are interested in providing such an app, reach out to [Wix Support](https://www.wix.com/support-chatbot?nodeId=25a57397-ccf7-4376-8b74-48d51edf7159&referral=devRels).
- Some calls in this API are asynchronous and return a job ID.
- All sessions are identified by their browser session IDs.
- An iframe [dashboard page extension](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/dashboard-pages/about-dashboard-page-extensions) is required.
- To use the analytics-session API, import the wix-analytics-session.v2 module. 
 ```import { analyticsSession } from "wix-analytics-session.v2";```
 
## Terminology

- **Session**: A visit of a visitor to a site. Within each session, a visitor can take multiple actions and view multiple pages.
- **Browser session ID**: An ID stored in the visitor's browser to identify the session.

velo-deps_wix-analytics-session.v2_analytics-session

ConversionFunnelSessionsParams

exclude

FunnelStep

include

CountFunnelSessionsOptions

Custom time period with start & end dates.

customTimePeriod

predefinedTimePeriod

User timezone. If not provided it will be taken from site properties.

timezone

CountFunnelSessionsResponse

recordings

Recordings

CountSessionsOptions

CountSessionsResponse

sessions

number

CustomTimePeriod

Custom period end date in provided timezone. Returned data will include all dates until the requested end date.
For example, { startDate: '2024-01-01', endDate: '2024-01-03' } will return data for '2024-01-01' and '2024-01-02'

endDate

Custom period start date in provided timezone.

startDate

DeviceType

limit

Number of items to skip in the current sort order.

offset

result

JobResult

jobStatus

JobStatus

total

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

conversionFunnel

deviceType

navigationFlow

User's timezone. Defaults to timezone as set in the [Site Properties API](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object).

NavigationFlowSessionsParams

Page interactions, including where the user dropped off. For example:
- ["/{Homepage}", "__DROP__"]: Sessions where a user visited the site's homepage and then dropped off.
- ["", "__DROP__"]: Sessions where a user visited (any page) and then dropped off.
- ["", "", "__DROP__"]: Session where a user visited any page, then navigated to any page, and then dropped off.

listSessionsAsync( )