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 |
|---|---|---|---|---|
|
|
integer |
Yes |
— |
The ID of the event to export online session data for |
|
|
boolean |
No |
|
When |
Response Format
Success Response (HTTP 200)
The data object contains multiple top-level keys:
|
Key |
Type |
Description |
|---|---|---|
|
|
array[object] |
Single-element array with aggregate statistics for the event |
|
|
array[object] |
One entry per session with aggregate per-session statistics |
|
|
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 |
|---|---|---|
|
|
string |
Total watch time across all sessions |
|
|
integer |
Total number of online sessions with recorded activity |
|
|
string |
Average participant count |
|
|
string |
Average watch time per session |
|
|
integer |
Unique participant count across all sessions |
Per-Session Sessions Entry Fields
|
Field |
Type |
Description |
|---|---|---|
|
|
integer |
Session ID |
|
|
string |
Online type label (e.g. |
|
|
string |
Session title |
|
|
integer |
Unique viewer count for this session |
|
|
integer |
Total view count for this session |
|
|
string |
Total watch time for this session |
Per-Date Participant Row Fields
|
Field |
Type |
Description |
|---|---|---|
|
|
integer |
Session ID |
|
|
string |
Date in |
|
|
string |
Start time in |
|
|
string |
Online type label |
|
|
string |
Session title |
|
|
integer |
Participant account ID |
|
|
string |
One of |
|
|
string |
First name |
|
|
string |
Last name |
|
|
string |
Email address |
|
|
string |
Watch time for this participant in this session |
|
|
string |
First entry timestamp |
|
|
string |
Last exit timestamp |
|
|
integer |
Total number of participants in this session occurrence |
Error Responses
|
HTTP Code |
Condition |
Error Message |
|---|---|---|
|
403 |
Missing or invalid API key |
|
Example Request
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"