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

# Get comprehensive dashboard metrics

> Use this endpoint to retrieve complete dashboard metrics including summary, trends, and breakdowns for the Command Center.



## OpenAPI

````yaml /en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/metrics
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Complete API reference for the Matcher reconciliation engine, providing
    automated transaction matching between Midaz Ledger and external systems.
  version: v2.1.1
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/reports/contexts/{contextId}/dashboard/metrics:
    get:
      tags:
        - Reporting
      summary: Get comprehensive dashboard metrics
      description: >-
        Use this endpoint to retrieve complete dashboard metrics including
        summary, trends, and breakdowns for the Command Center.
      operationId: getMatcherDashboardMetrics
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: The unique identifier of the reconciliation context.
          in: path
          name: contextId
          required: true
          schema:
            type: string
        - description: Start date (YYYY-MM-DD)
          in: query
          name: date_from
          required: true
          schema:
            type: string
        - description: End date (YYYY-MM-DD)
          in: query
          name: date_to
          required: true
          schema:
            type: string
        - description: Source ID filter
          in: query
          name: source_id
          schema:
            type: string
      responses:
        '200':
          description: >-
            Indicates that the request was successful and the response contains
            the expected data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatcherDashboardMetricsResponse'
        '400':
          description: The request contains invalid parameters or payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The request lacks valid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have permission to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    MatcherDashboardMetricsResponse:
      properties:
        breakdowns:
          $ref: '#/components/schemas/BreakdownMetricsResponse'
        summary:
          $ref: '#/components/schemas/SummaryMetricsResponse'
        trends:
          $ref: '#/components/schemas/TrendMetricsResponse'
        updatedAt:
          type: string
      type: object
    ErrorResponse:
      description: Standard error response returned by all API endpoints
      type: object
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: HTTP status code as a string.
          example: '404'
        title:
          type: string
          description: Error type identifier.
          example: not_found
        message:
          type: string
          description: Human-readable error message with details.
          example: context not found
        error:
          type: string
          description: Deprecated. Error message for backward compatibility.
          deprecated: true
        details:
          description: Additional error context as key-value pairs
          additionalProperties: {}
          type: object
    BreakdownMetricsResponse:
      properties:
        byAge:
          items:
            $ref: '#/components/schemas/AgeBucketDTO'
          type: array
        byReason:
          additionalProperties:
            type: integer
          type: object
        byRule:
          items:
            $ref: '#/components/schemas/RuleMatchCountDTO'
          type: array
        bySeverity:
          additionalProperties:
            type: integer
          type: object
      type: object
    SummaryMetricsResponse:
      properties:
        criticalExposure:
          type: string
        matchRate:
          type: number
        oldestExceptionAgeHours:
          type: number
        pendingExceptions:
          type: integer
        totalMatches:
          type: integer
        totalTransactions:
          type: integer
      type: object
    TrendMetricsResponse:
      properties:
        dates:
          items:
            type: string
          type: array
        exceptions:
          items:
            type: integer
          type: array
        ingestion:
          items:
            type: integer
          type: array
        matchRates:
          items:
            type: number
          type: array
        matches:
          items:
            type: integer
          type: array
      type: object
    AgeBucketDTO:
      properties:
        bucket:
          type: string
        value:
          type: integer
      type: object
    RuleMatchCountDTO:
      properties:
        count:
          type: integer
        id:
          type: string
        name:
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Bearer token authentication (format: "Bearer {token}")'

````