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

# Get dashboard overview



## OpenAPI

````yaml get /v1/dashboard/overview
openapi: 3.1.0
info:
  title: ReconLayer API
  version: 0.1.0
  summary: API-first reconciliation platform with dashboard-optional integration.
  description: >
    ReconLayer is designed to work headlessly.


    The dashboard is one consumer of this API, not the platform boundary.


    Organization resolution currently uses the `x-organization-id` header for
    development.

    In production, the intended model is:


    - dashboard requests authenticate through Clerk and the backend resolves the
    organization from the session

    - headless clients authenticate with API keys mapped to an organization

    - each API key can carry scopes for read/write/export/admin permissions


    Client write endpoints also use request-level idempotency.

    The client must generate an `Idempotency-Key` before the first attempt and

    reuse the same key on every retry of that same request.


    The route structure mirrors the domain:


    - `payment-intents` for expected payments

    - `reconciliation-cases` for reconciliation truth and workflow

    - `webhooks` for provider callbacks

    - `outbound-webhook-*` for client callback subscriptions and delivery
    tracking
servers:
  - url: https://api.reconlayer.com
security: []
tags:
  - name: dashboard
  - name: health
  - name: imports
  - name: outbound-webhooks
  - name: payment-intents
  - name: reconciliation-cases
  - name: integrations
  - name: settings
  - name: webhooks
paths:
  /v1/dashboard/overview:
    get:
      tags:
        - dashboard
      summary: Get dashboard overview
      parameters:
        - schema:
            type: string
            minLength: 1
          in: header
          name: authorization
          required: false
        - schema:
            type: string
            minLength: 1
          in: header
          name: x-organization-id
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-44'
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-98'
components:
  schemas:
    def-44:
      type: object
      required:
        - metrics
        - workloadTimeline
        - verdictDistribution
        - exceptionRootCauses
        - highPriorityExceptions
        - recentImportFailures
        - coverageWarnings
      properties:
        metrics:
          type: object
          required:
            - totalCases
            - openCases
            - reconciledCases
            - needsReviewCases
            - unreconciledCases
            - exceptionCases
            - invalidEvidenceCount
            - failedFileRows
          properties:
            totalCases:
              type: integer
            openCases:
              type: integer
            reconciledCases:
              type: integer
            needsReviewCases:
              type: integer
            unreconciledCases:
              type: integer
            exceptionCases:
              type: integer
            invalidEvidenceCount:
              type: integer
            failedFileRows:
              type: integer
        workloadTimeline:
          type: array
          items:
            type: object
            required:
              - date
              - casesCreated
              - importsCreated
              - open
              - resolved
              - review
              - exceptions
            properties:
              date:
                type: string
              casesCreated:
                type: integer
              importsCreated:
                type: integer
              open:
                type: integer
              resolved:
                type: integer
              review:
                type: integer
              exceptions:
                type: integer
        verdictDistribution:
          type: array
          items:
            type: object
            required:
              - verdict
              - count
            properties:
              verdict:
                type: string
              count:
                type: integer
        exceptionRootCauses:
          type: array
          items:
            type: object
            required:
              - exceptionType
              - count
            properties:
              exceptionType:
                type: string
              count:
                type: integer
        highPriorityExceptions:
          type: array
          items:
            type: object
            required:
              - caseId
              - externalReference
              - exceptionType
              - unexplainedDelta
              - updatedAt
            properties:
              caseId:
                type: string
              externalReference:
                type:
                  - 'null'
                  - string
              exceptionType:
                type:
                  - 'null'
                  - string
              unexplainedDelta:
                type:
                  - 'null'
                  - string
              updatedAt:
                type: string
                format: date-time
        recentImportFailures:
          type: array
          items:
            type: object
            required:
              - batchId
              - originalFileName
              - failedRows
              - createdAt
            properties:
              batchId:
                type: string
              originalFileName:
                type: string
              failedRows:
                type: integer
              createdAt:
                type: string
                format: date-time
        coverageWarnings:
          type: array
          items:
            type: object
            required:
              - caseId
              - externalReference
              - missingCoverage
            properties:
              caseId:
                type: string
              externalReference:
                type:
                  - 'null'
                  - string
              missingCoverage:
                type: array
                items:
                  type: string
      title: DashboardOverviewResponse
    def-98:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        message:
          type: string
        issues:
          type: array
          items:
            type: object
            additionalProperties: true
        details:
          type: object
          additionalProperties: true
        upstreamStatus:
          type: integer
      additionalProperties: true
      title: ApiErrorResponse

````