Skip to main content
GET
Get scenario participant analytics

Authorizations

Authorization
string
header
required

API key created in Settings > API.

Format: exec_live_ followed by 40 alphanumeric characters.

Path Parameters

scenario_id
string
required

Scenario identifier (UUID or slug)

Query Parameters

user_ids
string

Comma-separated user IDs to filter by. When combined with user_emails, results are unioned (all matching users from either list are included).

user_emails
string

Comma-separated user email addresses to filter by. When combined with user_ids, results are unioned (all matching users from either list are included).

group_ids
string

Comma-separated workspace group IDs to filter by

start_date
string<date-time>

ISO 8601 datetime — only include sessions on or after this date

end_date
string<date-time>

ISO 8601 datetime — only include sessions on or before this date

exclude_system_users
boolean
default:false

Exclude sessions from system users (emails ending in @exec.com). Default false.

sorting
enum<string>
default:-best_score

Sort field. Prefix with - for descending order.

Available options:
best_score,
-best_score,
first_score,
-first_score,
lift_percentage,
-lift_percentage,
total_duration_seconds,
-total_duration_seconds,
session_count,
-session_count
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
page_size
integer
default:50

Number of results per page (max 100)

Required range: 1 <= x <= 100

Response

Per-user participant analytics

data
object[]
pagination
object