POST sessions/getOnlineExport

POST /api/v2/sessions/getOnlineExport

Returns aggregated online session statistics and per-participant attendance data for a given event. Supports both live/breakout sessions and on-demand sessions via the on_demand flag.


Authentication

Authorization: Bearer <your_api_key>

Endpoint

POST /api/v2/sessions/getOnlineExport

Body Parameters

Submitted as multipart/form-data.

Parameter

Type

Required

Default

Description

event_id

integer

Yes

The ID of the event to export online session data for

on_demand

boolean

No

false

When true, returns on-demand session data. When false, returns live/breakout/livestream data


Response Format

Success Response (HTTP 200)

The data object contains multiple top-level keys:

Key

Type

Description

General info

array[object]

Single-element array with aggregate statistics for the event

Sessions

array[object]

One entry per session with aggregate per-session statistics

{DD-MM-YYYY}

array[object]

One key per calendar date on which sessions occurred; each entry is one row per participant per session

General info Fields (live mode)

Field

Type

Description

Total subscribed minutes

string

Total watch time across all sessions

Total sessions

integer

Total number of online sessions with recorded activity

Average number of participants per session

string

Average participant count

Average subscribed minutes per session

string

Average watch time per session

Number of unique users who have had session

integer

Unique participant count across all sessions

Per-Session Sessions Entry Fields

Field

Type

Description

Session ID

integer

Session ID

Session Type

string

Online type label (e.g. Breakout, Livestream, On-demand, External)

Session Title

string

Session title

Number of unique users who viewed this session

integer

Unique viewer count for this session

Total times this session was viewed

integer

Total view count for this session

Total subscribed minutes

string

Total watch time for this session

Per-Date Participant Row Fields

Field

Type

Description

Session ID

integer

Session ID

Session Date

string

Date in DD.MM.YYYY format (live) or date range (on-demand)

Session Time

string

Start time in HH:MM (live mode only)

Session Type

string

Online type label

Session Title

string

Session title

Account ID

integer

Participant account ID

Account Type

string

One of Visitor, Exhibitor Owner, Exhibitor Team Member, Buyer

Account First Name

string

First name

Account Last Name

string

Last name

Account Email

string

Email address

Subscribed time

string

Watch time for this participant in this session

Enter time

string

First entry timestamp

Exit time

string

Last exit timestamp

Participants count

integer

Total number of participants in this session occurrence


Error Responses

HTTP Code

Condition

Error Message

403

Missing or invalid API key

Forbidden


Example Request

Bash
curl -X POST "https://your-event-domain.com/api/v2/sessions/getOnlineExport" \
  -H "Authorization: Bearer your_api_key_here" \
  -F "event_id=7" \
  -F "on_demand=false"