> ## 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 source breakdown

> Use this endpoint to retrieve a breakdown of reconciliation metrics by source for a specific context and date range. Shows match rates, transaction counts, and unmatched amounts per source.



## OpenAPI

````yaml /en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/source-breakdown
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/source-breakdown:
    get:
      tags:
        - Reporting
      summary: Get source breakdown
      description: >-
        Use this endpoint to retrieve a breakdown of reconciliation metrics by
        source for a specific context and date range. Shows match rates,
        transaction counts, and unmatched amounts per source.
      operationId: getSourceBreakdown
      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: Source breakdown metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceBreakdownListResponse'
        '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'
      security:
        - BearerAuth: []
components:
  schemas:
    SourceBreakdownListResponse:
      description: List of source breakdown metrics
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SourceBreakdownResponse'
    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
    SourceBreakdownResponse:
      description: Reconciliation metrics breakdown for a single source
      type: object
      properties:
        sourceId:
          type: string
          description: Source identifier
        sourceName:
          type: string
          description: Source display name
        totalTransactions:
          type: integer
          format: int64
          description: Total number of transactions from this source
        matchedTransactions:
          type: integer
          format: int64
          description: Number of matched transactions
        unmatchedTransactions:
          type: integer
          format: int64
          description: Number of unmatched transactions
        matchRate:
          type: number
          format: double
          description: Match rate as a decimal (0.0 to 1.0)
        totalAmount:
          type: string
          description: Total transaction amount (decimal string for precision)
        unmatchedAmount:
          type: string
          description: Total unmatched amount (decimal string for precision)
        currency:
          type: string
          description: Currency code
          example: USD
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Bearer token authentication (format: "Bearer {token}")'

````