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

# Get the dashboard summary

> Return the home-screen 24h operational pulse in a single call: batch counts by status over the last 24 hours, the most recent failures (denormalized for click-through), the active-schedule count, and the next few upcoming schedule fires. All figures are scoped to the caller's account.



## OpenAPI

````yaml /openapi.json get /dashboard/summary
openapi: 3.1.0
info:
  title: GetDialed Flows API
  version: 0.1.0
servers:
  - url: https://api.getdialed.ai/flows
    description: Production
security: []
paths:
  /dashboard/summary:
    get:
      tags:
        - dashboard
      summary: Get the dashboard summary
      description: >-
        Return the home-screen 24h operational pulse in a single call: batch
        counts by status over the last 24 hours, the most recent failures
        (denormalized for click-through), the active-schedule count, and the
        next few upcoming schedule fires. All figures are scoped to the caller's
        account.
      operationId: get_dashboard_summary_dashboard_summary_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardSummaryResponse'
        '401':
          description: Missing or invalid authentication
          content:
            application/json:
              example:
                detail: Authentication required
        '422':
          description: Validation error (see body for field details)
          content:
            application/json:
              example:
                detail: Validation error
        '429':
          description: Rate limit exceeded — retry after the Retry-After header
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
          content:
            application/json:
              example:
                detail: 'Rate limit exceeded: 100 per 1 minute'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    DashboardSummaryResponse:
      properties:
        batches_by_status:
          additionalProperties:
            type: integer
          type: object
          title: Batches By Status
          description: Batch counts keyed by status over the last 24 hours.
        recent_failures:
          items:
            $ref: '#/components/schemas/RecentFailure'
          type: array
          title: Recent Failures
          description: The most recent failed batches, newest first.
        active_schedule_count:
          type: integer
          title: Active Schedule Count
          description: Number of currently-enabled schedules.
        upcoming_fires:
          items:
            $ref: '#/components/schemas/UpcomingFire'
          type: array
          title: Upcoming Fires
          description: The next few upcoming schedule fires, soonest first.
      type: object
      required:
        - batches_by_status
        - recent_failures
        - active_schedule_count
        - upcoming_fires
      title: DashboardSummaryResponse
      description: The one-call home-screen summary (24h pulse).
      example:
        active_schedule_count: 6
        batches_by_status:
          completed: 128
          failed: 4
          running: 2
        recent_failures:
          - definition_id: def_a1b2c3d4
            failed_at: '2026-07-09T18:00:05Z'
            id: batch_55667788
            source: schedule
        upcoming_fires:
          - definition_id: def_a1b2c3d4
            next_fire_at: '2026-07-10T09:00:00Z'
            schedule_id: sched_1a2b
    RecentFailure:
      properties:
        id:
          type: string
          title: Id
          description: The failed batch's id.
        definition_id:
          type: string
          title: Definition Id
          description: The definition that produced the failed batch.
        source:
          type: string
          title: Source
          description: How the batch was triggered (e.g. api, schedule).
        failed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Failed At
          description: When the batch reached its failed/partially-failed terminal state.
      type: object
      required:
        - id
        - definition_id
        - source
      title: RecentFailure
      description: >-
        A recently failed batch, denormalized enough to render a clickable row.


        No client-side joins: the definition id and source travel with the row
        so

        the failure feed renders directly (D-11).
    UpcomingFire:
      properties:
        schedule_id:
          type: string
          title: Schedule Id
          description: The schedule that will fire.
        definition_id:
          type: string
          title: Definition Id
          description: The definition the schedule triggers.
        next_fire_at:
          type: string
          format: date-time
          title: Next Fire At
          description: The next fire time, computed from the cron expression (UTC).
      type: object
      required:
        - schedule_id
        - definition_id
        - next_fire_at
      title: UpcomingFire
      description: The next computed fire time for an active schedule (read-time croniter).
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````