About the Analytics Sessions API

The Analytics Sessions API enables developers 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 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.
• 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.
• 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.