> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get dashboard overview metrics

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



## OpenAPI

````yaml https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /dashboard/overview
openapi: 3.0.0
info:
  title: SIMULATOR OPENAPI REST-ful-API Reference
  version: 2025.20.0
  description: >

    ### Introduction

    This is the [OpenAPI 3.0](https://swagger.io/specification/) documentation

    of the
    [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-ful
    SIMULATOR OPENAPI API.


    ### Cross-Origin Resource Sharing

    This API features Cross-Origin Resource Sharing (CORS) implemented in

    compliance with [W3C spec](https://www.w3.org/TR/cors/), which allows

    cross-domain communication from the browser. All responses have a wildcard

    same-origin header which makes the API completely accessible.


    ### Authentication

    SIMULATOR OPENAPI offers following forms of authentication:

    - Bearer Token (JWT)

    - API Key


    ### Error Handling

    This API uses HTTP status codes equal or above 400 to indicate errors. Error

    details are generated in compliance with [RFC 7807 - "Problem Details for
    HTTP APIs"](https://tools.ietf.org/html/rfc7807).


    Every error response contains a traceId, which should be provided to the
    SIMULATOR OPENAPI Technical Support when reporting an error.
  contact:
    name: Cognigy Technical Support
    url: https://www.cognigy.com
    email: support@cognigy.com
  license:
    name: Cognigy Proprietary License
servers:
  - url: https://api-trial.cognigy.ai/testing
    description: Cognigy Service Testing API
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Simulations
    description: >-
      Simulation management operations - Create, read, update, and delete
      simulations
externalDocs:
  description: SIMULATOR OPENAPI Documentation
  url: https://docs.cognigy.com/docs/service-testing/
paths:
  /dashboard/overview:
    get:
      tags:
        - Dashboard
      summary: Get dashboard overview metrics
      description: >-
        Retrieve key metrics for the dashboard overview cards including total
        scenarios, simulations, average success rate, and scheduled runs count.
      operationId: getDashboardOverview
      parameters:
        - name: projectId
          in: query
          required: true
          schema:
            type: string
          description: Project identifier
        - name: scenarioIds
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
          description: >-
            Filter by scenario/simulation reference IDs (comma-separated or
            array). If not provided, includes all scenarios.
          example:
            - sim-ref-1
            - sim-ref-2
        - name: timeWindow
          in: query
          required: false
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - 3m
            default: 7d
          description: >-
            Time window for data aggregation. Options: 7d (last 7 days), 30d
            (last 30 days), 3m (last 3 months)
      responses:
        '200':
          description: Dashboard overview metrics retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalScenarios:
                    type: integer
                    description: Count of all active test scenarios (simulations)
                    example: 15
                  totalSimulations:
                    type: integer
                    description: >-
                      Number of completed simulation runs (manual + scheduled)
                      within the time window
                    example: 142
                  avgSuccessRate:
                    type: number
                    format: float
                    minimum: 0
                    maximum: 100
                    description: >-
                      Average success rate across all recent simulations
                      (weighted by number of runs) within the time window
                    example: 87.5
                  scheduledRuns:
                    type: integer
                    description: >-
                      Count of currently active schedules (simulations with
                      status IN_PROGRESS)
                    example: 8
                required:
                  - totalScenarios
                  - totalSimulations
                  - avgSuccessRate
                  - scheduledRuns
        '400':
          description: Bad Request - Invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Validation error message
                  field:
                    type: string
                    description: Field that failed validation
                  code:
                    type: string
                    description: Validation error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
                  - field
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Unauthorized error message
                  code:
                    type: string
                    description: Unauthorized error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Forbidden error message
                  code:
                    type: string
                    description: Forbidden error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
        '500':
          description: Internal Server Error - Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                  code:
                    type: string
                    description: Error code
                  traceId:
                    type: string
                    description: Trace ID for debugging
                required:
                  - error
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT Bearer Token for authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````