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

# Get dashboard metrics

> Returns aggregated payment metrics for the authenticated user's company.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/dashboard
openapi: 3.0.0
info:
  title: PlugToPay API
  description: API to make payments easy in multiple gateways.
  version: 1.0.0
servers:
  - url: http://localhost:7701
    description: Test Server
security: []
paths:
  /api/v1/dashboard:
    get:
      tags:
        - Dashboard
      summary: Get dashboard metrics
      description: Returns aggregated payment metrics for the authenticated user's company.
      operationId: 3b908e729c3164b44e7a504f7fe896e1
      parameters:
        - $ref: '#/components/parameters/XClientId'
        - name: start_date
          in: query
          required: false
          schema:
            type: string
            format: date
            example: '2026-01-01'
        - name: end_date
          in: query
          required: false
          schema:
            type: string
            format: date
            example: '2026-12-31'
      responses:
        '200':
          description: Dashboard metrics
          content:
            application/json:
              schema:
                properties:
                  total_processed_amount:
                    type: integer
                    example: 1500000
                  total_transactions:
                    type: integer
                    example: 320
                  approval_rate:
                    type: number
                    format: float
                    example: 87.5
                  recovered_payments:
                    type: integer
                    example: 12
                  conversion_by_gateway:
                    type: array
                    items:
                      properties:
                        gateway:
                          type: string
                          example: pagarme
                        total:
                          type: integer
                          example: 200
                        approved:
                          type: integer
                          example: 175
                        rate:
                          type: number
                          format: float
                          example: 87.5
                      type: object
                  failure_reasons:
                    type: array
                    items:
                      properties:
                        reason:
                          type: string
                          example: Insufficient funds
                        count:
                          type: integer
                          example: 18
                      type: object
                  last_transactions:
                    type: array
                    items:
                      type: object
                type: object
        '401':
          description: Unauthorized — Missing or invalid JWT
      security:
        - BearerAuth: []
components:
  parameters:
    XClientId:
      name: x-client-id
      in: header
      description: Client identifier for the company in the request.
      required: true
      schema:
        type: string
        example: client_abc123
  securitySchemes:
    BearerAuth:
      type: http
      description: >-
        User JWT token — obtained from /api/v1/auth/login or
        /api/v1/auth/register.
      bearerFormat: JWT
      scheme: bearer

````