About the Analytics Sessions API

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

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.

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

Use cases

• Record a visitor session and notify Wix that a recording has been made.
• Display session recordings to Wix users based on Wix's filter data.

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.
• 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 is required.

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.

Setup

To use the AnalyticsSession API, install the @wix/analytics-session package using npm or Yarn:

npm install @wix/analytics-session

or

yarn add @wix/analytics-session

Then import { analyticsSession } from @wix/analytics-session:

import { analyticsSession } from "@wix/analytics-session";