About the Analytics Sessions API

The Analytics Sessions API enables select beta users to access session IDs collected from Wix sites.

A session refers to a visitor's interaction with a site, beginning when they arrive and concluding after 30 minutes of inactivity. During each session, a visitor can take multiple actions and navigate through multiple pages. Each session is uniquely identified by a browser session ID.

Wix offers Wix users an entry point to access selected analytics apps that record and track visitor sessions. When a Wix user 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.

Use cases

• Record a visitor session and notify Wix that a recording has been made.
• Display session recordings to 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.

Sample flows

This article shares some possible use cases your app could support, as well as an example flow that could support each use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.

Record a visitor session and notify Wix that a recording has been made

When your app recognizes that a visitor session has begun, your app should:

1. Collect the browser session ID.
2. Record the visitor's session on the site, and map it to the browser session ID.
3. Notify Wix that a recording has been made by calling the Mark Session as Recorded endpoint and passing the browser session ID.

Display session recordings to users based on Wix's filter data

When a site user (admin or contributor) accesses the dedicated entry point for your app:

1. Wix calls your extension's iframe URL with filter data as query parameters.
2. Collect the filter data from the query parameters.
3. Call List Sessions Async with the filters from step 2.
4. Collect the job ID and call Get List Sessions Job Result.
5. If the job is complete, collect the returned session IDs.
6. Display the browser sessions with the IDs returned in step 5.