curl --request GET \
--url https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"participant_count": 45,
"total_sessions": 128,
"average_best_score": 74.2,
"average_best_rank": "silver",
"average_lift_percentage": 18.5,
"total_practice_minutes": 742,
"average_session_duration_seconds": 348,
"score_distribution": [
{
"rank": "gold",
"count": 12,
"percentage": 26.7
},
{
"rank": "silver",
"count": 18,
"percentage": 40
},
{
"rank": "bronze",
"count": 10,
"percentage": 22.2
},
{
"rank": "unranked",
"count": 5,
"percentage": 11.1
}
]
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid or inactive API key"
}
}{
"error": {
"type": "not_found",
"message": "Scenario not found: abc123"
}
}Get scenario analytics summary
Returns aggregate metrics for a scenario: participant count, total sessions, average best score and rank, average lift, total practice minutes, and average session duration. Accepts both UUID and slug for the scenario identifier.
curl --request GET \
--url https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exec.com/rest/v1/scenarios/{scenario_id}/analytics/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"participant_count": 45,
"total_sessions": 128,
"average_best_score": 74.2,
"average_best_rank": "silver",
"average_lift_percentage": 18.5,
"total_practice_minutes": 742,
"average_session_duration_seconds": 348,
"score_distribution": [
{
"rank": "gold",
"count": 12,
"percentage": 26.7
},
{
"rank": "silver",
"count": 18,
"percentage": 40
},
{
"rank": "bronze",
"count": 10,
"percentage": 22.2
},
{
"rank": "unranked",
"count": 5,
"percentage": 11.1
}
]
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid or inactive API key"
}
}{
"error": {
"type": "not_found",
"message": "Scenario not found: abc123"
}
}Authorizations
API key created in Settings > API.
Format: exec_live_ followed by 40 alphanumeric characters.
Path Parameters
Scenario identifier (UUID or slug)
Query Parameters
Comma-separated user IDs to filter by. When combined with user_emails, results are unioned (all matching users from either list are included).
Comma-separated user email addresses to filter by. When combined with user_ids, results are unioned (all matching users from either list are included).
Comma-separated workspace group IDs to filter by
ISO 8601 datetime — only include sessions on or after this date
ISO 8601 datetime — only include sessions on or before this date
Exclude sessions from system users (emails ending in @exec.com). Default false.
Response
Scenario analytics summary
Aggregate analytics metrics for a scenario.
Number of unique participants with graded sessions
Total number of graded sessions
Average of each participant's best score (0-100)
Rank corresponding to the average best score
gold, silver, bronze, unranked Average improvement (best - first score) across participants
Total practice time across all sessions in minutes
Average duration per session in seconds
Rank distribution across participants based on best scores (Gold ≥90, Silver ≥75, Bronze ≥50, Unranked <50).
Show child attributes
Show child attributes