Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Dashboard

Get dashboard overview metrics

Retrieve key metrics for the dashboard overview cards including total scenarios, simulations, average success rate, and scheduled runs count.

get/dashboard/overview

Query parameters

projectIdstring required

Project identifier

scenarioIdsstring[]

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

timeWindow'7d' | '30d' | '3m'

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

Response

Dashboard overview metrics retrieved successfully

totalScenariosinteger required

Count of all active test scenarios (simulations)

totalSimulationsinteger required

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

avgSuccessRatenumber float required

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

scheduledRunsinteger required

Count of currently active schedules (simulations with status IN_PROGRESS)

Example response

{
  "totalScenarios": 15,
  "totalSimulations": 142,
  "avgSuccessRate": 87.5,
  "scheduledRuns": 8
}
All 395 operations