> ## 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 Dashboard Workflow Summary

> Use this endpoint to retrieve an aggregated summary of workflows, including totals and breakdowns by status.



## OpenAPI

````yaml /en/openapi/v3-current/flowker.yaml get /v1/dashboards/workflows/summary
openapi: 3.1.0
info:
  description: >-
    Complete API reference for Flowker workflow orchestration services including
    catalog management, workflow definitions, executor configurations, provider
    configurations, and workflow executions.
  title: Flowker API
  version: 1.1.0
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Health API
    description: Health and version endpoints for monitoring the Flowker service.
  - name: Catalog API
    description: >-
      Browse built-in providers, executors, and triggers available in the
      Flowker catalog.
  - name: Workflows API
    description: >-
      Create, update, activate, deactivate, clone, and delete workflow
      definitions.
  - name: Executions API
    description: Start workflow executions and track their status and results.
  - name: Executor Configurations API
    description: >-
      Configure, test, and manage external executor connections used by workflow
      nodes.
  - name: Provider Configurations API
    description: Configure, test, enable, and disable provider integrations.
  - name: Dashboard API
    description: >-
      Retrieve aggregated summaries of workflows and executions for operational
      dashboards.
  - name: Audit API
    description: Query and verify audit events for compliance and operational visibility.
  - name: Webhooks API
    description: >-
      Receive webhook callbacks from external systems to trigger workflow
      executions.
paths:
  /v1/dashboards/workflows/summary:
    get:
      tags:
        - Dashboard API
      summary: Get Dashboard Workflow Summary
      description: >-
        Use this endpoint to retrieve an aggregated summary of workflows,
        including totals and breakdowns by status.
      operationId: getDashboardWorkflowSummary
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowSummaryOutput'
          description: >-
            Indicates that the request was successful and the response contains
            the requested data.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates an unexpected internal error. If this persists, please
            contact support.
components:
  schemas:
    WorkflowSummaryOutput:
      description: Aggregated summary of all workflows grouped by status.
      properties:
        total:
          description: Total number of workflows.
          example: 15
          type: integer
        active:
          description: Number of currently active workflows.
          example: 8
          type: integer
        byStatus:
          description: Breakdown of workflows by status.
          items:
            $ref: '#/components/schemas/StatusCountOutput'
          type: array
      type: object
    ErrorResponse:
      properties:
        code:
          description: Machine-readable error code with the FLK prefix.
          example: FLK-0001
          type: string
        message:
          description: Human-readable explanation of the error.
          example: Invalid input provided
          type: string
        title:
          description: Short error category title.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
    StatusCountOutput:
      description: Count of items grouped by status.
      properties:
        status:
          description: Status value.
          example: active
          type: string
        count:
          description: Number of items with this status.
          example: 8
          type: integer
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authenticating requests to the Flowker API. Provisioned via
        the API_KEY environment variable during deployment.

````