Skip to main content
GET
Get dashboard overview metrics

Authorizations

Authorization
string
header
required

JWT Bearer Token for authentication

Query Parameters

projectId
string
required

Project identifier

scenarioIds
string[]

Filter by scenario/simulation reference IDs (comma-separated or array). If not provided, includes all scenarios.

timeWindow
enum<string>
default:7d

Time window for data aggregation. Options: 7d (last 7 days), 30d (last 30 days), 3m (last 3 months)

Available options:
7d,
30d,
3m
timezone
string

IANA timezone (e.g. 'Europe/Berlin') whose calendar days define the time window and the daily buckets. Defaults to UTC.

Response

Dashboard overview metrics retrieved successfully

totalScenarios
integer
required

Count of all active test scenarios (simulations)

Example:

15

totalSimulations
integer
required

Number of completed simulation runs (manual + scheduled) within the time window

Example:

142

avgSuccessRate
number<float>
required

Average success rate across all recent simulations (weighted by number of runs) within the time window

Required range: 0 <= x <= 100
Example:

87.5

scheduledRuns
integer
required

Count of currently active schedules (simulations with status IN_PROGRESS)

Example:

8