---
title: "Get dashboard overview metrics"
method: GET
path: "/dashboard/overview"
tags: ["Dashboard"]
---

# Get dashboard overview metrics

`GET /dashboard/overview`

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

## Query parameters

- `projectId` string, required
- `scenarioIds` string[]
- `timeWindow` '7d' | '30d' | '3m'

## Response `200`

Dashboard overview metrics retrieved successfully

- object
  - `totalScenarios` integer, required — Count of all active test scenarios (simulations)
  - `totalSimulations` integer, required — Number of completed simulation runs (manual + scheduled) within the time window
  - `avgSuccessRate` number, float, required — Average success rate across all recent simulations (weighted by number of runs) within the time window
  - `scheduledRuns` integer, required — Count of currently active schedules (simulations with status IN_PROGRESS)

## Other responses

- `400` — Bad Request - Invalid input parameters
- `401` — Unauthorized - Invalid or missing authentication
- `403` — Forbidden - Insufficient permissions
- `500` — Internal Server Error - Server error

---

[API](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) · [All operations](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cognigy/simulator-openapi-rest-ful-api-reference/versions/85b2872bdfb7/schema)