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

# Get the workspace overview dashboard

> Returns the unique shared Workspace overview and its ordered widget configuration.



## OpenAPI

````yaml /openapi-public.json get /dashboards/workspace_overview
openapi: 3.1.0
info:
  title: Akua API
  version: 1.0.0
  description: >-
    Public API for managing Akua workspaces, clusters, products, and installs.


    Authenticate with a workspace API token via the `Authorization: Bearer
    sk_akua_...` header.


    A workspace-owned token implies its workspace. Broad tokens select the
    active workspace via the optional `Akua-Context` header.
  contact:
    name: Akua API support
    email: support@akua.dev
    url: https://akua.dev/docs
servers:
  - url: https://api.akua.dev/v1
    description: Production
security: []
tags:
  - name: Auth
    description: Authentication and token management.
  - name: Agents
    description: Agent identities and configuration.
  - name: Agent sessions
    description: Durable agent conversations and tasks.
  - name: Agent turns
    description: Submitted agent work and event emission.
  - name: Agent events
    description: Normalized agent event history and streams.
  - name: Custom domains
    description: Workspace custom domains and routing targets.
  - name: Cloudflare
    description: Cloudflare account credentials and gateway control.
  - name: Clusters
    description: Kubernetes clusters and cluster access operations.
  - name: ComputeConfigs
    description: Workspace compute provider configurations.
  - name: Entitlements
    description: Effective workspace capabilities and limits.
  - name: Dashboards
    description: Dashboard and widget resources.
  - name: Installs
    description: Installation and render operations.
  - name: Machines
    description: Compute machines and lifecycle events.
  - name: Notifications
    description: User notification state.
  - name: Offer Channels
    description: Private offer channels and policy versions.
  - name: Offers
    description: Marketplace offers and redemption tracking.
  - name: Operations
    description: Long-running operation status and controls.
  - name: Order Drafts
    description: Draft checkout orders and checkout sessions.
  - name: Organizations
    description: Organizations, memberships, and managed workspaces.
  - name: Packages
    description: Software packages, versions, and input schemas.
  - name: Products
    description: Marketplace product catalog resources.
  - name: Preview hostnames
    description: Install preview hostnames and routing state.
  - name: Quotas
    description: Workspace quota limits and usage.
  - name: Regions
    description: Available deployment regions.
  - name: Registry
    description: Container registry credentials and repositories.
  - name: Repository change requests
    description: Fork-backed repository change reviews and lifecycle actions.
  - name: Repositories
    description: Source repositories available to the workspace.
  - name: Secrets
    description: Workspace secrets and secret versions.
  - name: Snippets
    description: Reusable snippets and snippet runs.
  - name: Workspace subdomains
    description: Workspace subdomain identity.
  - name: Workspaces
    description: Workspace resources, members, and billing state.
paths:
  /dashboards/workspace_overview:
    get:
      tags:
        - Dashboards
      summary: Get the workspace overview dashboard
      description: >-
        Returns the unique shared Workspace overview and its ordered widget
        configuration.
      operationId: dashboards.getWorkspaceOverview
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 53
            description: >-
              Optional workspace/scope context for the request. Carries a single
              workspace wire id (`ws_…`) today. Only needed for broad tokens — a
              workspace-owned token implies its workspace.
            example: ws_j572abc123def456
          required: false
          description: >-
            Optional workspace/scope context for the request. Carries a single
            workspace wire id (`ws_…`) today. Only needed for broad tokens — a
            workspace-owned token implies its workspace.
          name: akua-context
          in: header
      responses:
        '200':
          description: Workspace overview dashboard
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    Dashboard:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 55
          example: dash_j572abc123def456
        html_url:
          type: string
          maxLength: 2048
          format: uri
          description: Absolute dashboard URL for this resource. OUTPUT_ONLY.
          example: https://akua.dev/dashboards/dash_j572abc123def456
        name:
          type: string
          example: Cluster Overview
        description:
          type:
            - string
            - 'null'
          description: Optional dashboard description
        workspace_id:
          type: string
          minLength: 1
          maxLength: 53
        purpose:
          type: string
          enum:
            - workspace_overview
            - custom
        filter_definitions:
          type: array
          items:
            oneOf:
              - type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - time
                  key:
                    type: string
                    enum:
                      - time
                  label:
                    type: string
                    minLength: 1
                    maxLength: 100
                required:
                  - kind
                  - key
                  - label
                additionalProperties: false
              - type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - comparison
                  key:
                    type: string
                    enum:
                      - comparison
                  label:
                    type: string
                    minLength: 1
                    maxLength: 100
                required:
                  - kind
                  - key
                  - label
                additionalProperties: false
              - type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - resource
                  key:
                    type: string
                    enum:
                      - cluster
                      - install
                      - product
                      - package
                      - region
                  resource:
                    type: string
                    enum:
                      - cluster
                      - install
                      - product
                      - package
                      - region
                  label:
                    type: string
                    minLength: 1
                    maxLength: 100
                required:
                  - kind
                  - key
                  - resource
                  - label
                additionalProperties: false
              - type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - status
                  key:
                    type: string
                    enum:
                      - status
                  label:
                    type: string
                    minLength: 1
                    maxLength: 100
                  options:
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 100
                    minItems: 1
                    maxItems: 100
                required:
                  - kind
                  - key
                  - label
                  - options
                additionalProperties: false
              - type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - variable
                  key:
                    type: string
                    pattern: ^var\.[a-z][a-z0-9_]{0,31}$
                  input:
                    oneOf:
                      - type: object
                        properties:
                          key:
                            type: string
                            pattern: ^[a-z][a-z0-9_]{0,31}$
                          label:
                            type: string
                            minLength: 1
                            maxLength: 100
                          description:
                            type: string
                            maxLength: 500
                          required:
                            type: boolean
                          kind:
                            type: string
                            enum:
                              - time_range
                          default:
                            type: object
                            properties:
                              from:
                                type: integer
                              to:
                                type: integer
                            required:
                              - from
                              - to
                            additionalProperties: false
                        required:
                          - key
                          - label
                          - kind
                        additionalProperties: false
                      - type: object
                        properties:
                          key:
                            type: string
                            pattern: ^[a-z][a-z0-9_]{0,31}$
                          label:
                            type: string
                            minLength: 1
                            maxLength: 100
                          description:
                            type: string
                            maxLength: 500
                          required:
                            type: boolean
                          kind:
                            type: string
                            enum:
                              - resource
                          resource:
                            type: string
                            enum:
                              - cluster
                              - install
                              - product
                              - package
                              - region
                          default:
                            anyOf:
                              - type: string
                                maxLength: 255
                              - type: array
                                items:
                                  type: string
                                  maxLength: 255
                                minItems: 1
                                maxItems: 100
                          multiple:
                            type: boolean
                        required:
                          - key
                          - label
                          - kind
                          - resource
                        additionalProperties: false
                      - type: object
                        properties:
                          key:
                            type: string
                            pattern: ^[a-z][a-z0-9_]{0,31}$
                          label:
                            type: string
                            minLength: 1
                            maxLength: 100
                          description:
                            type: string
                            maxLength: 500
                          required:
                            type: boolean
                          kind:
                            type: string
                            enum:
                              - enum
                          options:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 100
                            minItems: 1
                            maxItems: 100
                          default:
                            type: string
                            minLength: 1
                            maxLength: 100
                        required:
                          - key
                          - label
                          - kind
                          - options
                        additionalProperties: false
                      - type: object
                        properties:
                          key:
                            type: string
                            pattern: ^[a-z][a-z0-9_]{0,31}$
                          label:
                            type: string
                            minLength: 1
                            maxLength: 100
                          description:
                            type: string
                            maxLength: 500
                          required:
                            type: boolean
                          kind:
                            type: string
                            enum:
                              - boolean
                          default:
                            type: boolean
                        required:
                          - key
                          - label
                          - kind
                        additionalProperties: false
                      - type: object
                        properties:
                          key:
                            type: string
                            pattern: ^[a-z][a-z0-9_]{0,31}$
                          label:
                            type: string
                            minLength: 1
                            maxLength: 100
                          description:
                            type: string
                            maxLength: 500
                          required:
                            type: boolean
                          kind:
                            type: string
                            enum:
                              - number
                          min:
                            type: number
                          max:
                            type: number
                          default:
                            type: number
                        required:
                          - key
                          - label
                          - kind
                        additionalProperties: false
                      - type: object
                        properties:
                          key:
                            type: string
                            pattern: ^[a-z][a-z0-9_]{0,31}$
                          label:
                            type: string
                            minLength: 1
                            maxLength: 100
                          description:
                            type: string
                            maxLength: 500
                          required:
                            type: boolean
                          kind:
                            type: string
                            enum:
                              - text
                          default:
                            type: string
                            maxLength: 500
                          max_length:
                            type: integer
                            minimum: 1
                            maximum: 500
                        required:
                          - key
                          - label
                          - kind
                        additionalProperties: false
                required:
                  - kind
                  - key
                  - input
                additionalProperties: false
          maxItems: 24
        default_filter_values:
          type: object
          additionalProperties: {}
        active_revision_id:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 55
        widgets:
          type: array
          items:
            $ref: '#/components/schemas/Widget'
          description: Output-only denormalized widget list for dashboard read models.
        created_by:
          type: string
          description: User ID of the dashboard creator
        created_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
        updated_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
        etag:
          type: string
      required:
        - id
        - html_url
        - name
        - description
        - workspace_id
        - purpose
        - filter_definitions
        - default_filter_values
        - active_revision_id
        - widgets
        - created_by
        - created_at
        - updated_at
        - etag
    ApiErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          properties: {}
          description: Always empty for error responses
      required:
        - success
        - errors
        - result
    Widget:
      oneOf:
        - type: object
          properties:
            id:
              type: string
              minLength: 1
              maxLength: 54
            dashboard_id:
              type: string
              minLength: 1
              maxLength: 55
            title:
              type:
                - string
                - 'null'
              maxLength: 100
            position:
              type: integer
            col_span:
              anyOf:
                - type: number
                  enum:
                    - 1
                - type: number
                  enum:
                    - 2
                - type: number
                  enum:
                    - 3
                - type: number
                  enum:
                    - 4
            height:
              type: string
              enum:
                - compact
                - standard
                - tall
            drill_down:
              type:
                - string
                - 'null'
              minLength: 1
              maxLength: 2048
            visualization_options:
              type: object
              additionalProperties: {}
            freshness_policy:
              oneOf:
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - provider_default
                  required:
                    - mode
                  additionalProperties: false
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - max_age
                    max_age_seconds:
                      type: integer
                      minimum: 30
                      maximum: 86400
                  required:
                    - mode
                    - max_age_seconds
                  additionalProperties: false
            created_at:
              type: integer
              minimum: 0
              description: Unix timestamp (seconds)
            updated_at:
              type: integer
              minimum: 0
              description: Unix timestamp (seconds)
            etag:
              type: string
            widget_type:
              type: string
              enum:
                - platform_metric
            metric_key:
              type: string
              minLength: 1
              maxLength: 100
              pattern: ^[a-z][a-z0-9_]*$
            metric_version:
              type: integer
              exclusiveMinimum: 0
            filter_bindings:
              type: object
              additionalProperties:
                oneOf:
                  - type: object
                    properties:
                      mode:
                        type: string
                        enum:
                          - inherit
                      filter_key:
                        anyOf:
                          - type: string
                            enum:
                              - time
                              - comparison
                              - cluster
                              - install
                              - product
                              - package
                              - region
                              - status
                          - type: string
                            pattern: ^var\.[a-z][a-z0-9_]{0,31}$
                    required:
                      - mode
                      - filter_key
                    additionalProperties: false
                  - type: object
                    properties:
                      mode:
                        type: string
                        enum:
                          - fixed
                      value: {}
                    required:
                      - mode
                      - value
                    additionalProperties: false
                  - type: object
                    properties:
                      mode:
                        type: string
                        enum:
                          - unbound
                    required:
                      - mode
                    additionalProperties: false
          required:
            - id
            - dashboard_id
            - title
            - position
            - col_span
            - height
            - drill_down
            - visualization_options
            - freshness_policy
            - created_at
            - updated_at
            - etag
            - widget_type
            - metric_key
            - metric_version
            - filter_bindings
          additionalProperties: false
        - type: object
          properties:
            id:
              type: string
              minLength: 1
              maxLength: 54
            dashboard_id:
              type: string
              minLength: 1
              maxLength: 55
            title:
              type:
                - string
                - 'null'
              maxLength: 100
            position:
              type: integer
            col_span:
              anyOf:
                - type: number
                  enum:
                    - 1
                - type: number
                  enum:
                    - 2
                - type: number
                  enum:
                    - 3
                - type: number
                  enum:
                    - 4
            height:
              type: string
              enum:
                - compact
                - standard
                - tall
            drill_down:
              type:
                - string
                - 'null'
              minLength: 1
              maxLength: 2048
            visualization_options:
              type: object
              additionalProperties: {}
            freshness_policy:
              oneOf:
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - provider_default
                  required:
                    - mode
                  additionalProperties: false
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - max_age
                    max_age_seconds:
                      type: integer
                      minimum: 30
                      maximum: 86400
                  required:
                    - mode
                    - max_age_seconds
                  additionalProperties: false
            created_at:
              type: integer
              minimum: 0
              description: Unix timestamp (seconds)
            updated_at:
              type: integer
              minimum: 0
              description: Unix timestamp (seconds)
            etag:
              type: string
            widget_type:
              type: string
              enum:
                - snippet
            snippet_id:
              type: string
              minLength: 1
              maxLength: 54
            snippet_etag:
              type:
                - string
                - 'null'
            input_bindings:
              type: object
              additionalProperties:
                oneOf:
                  - type: object
                    properties:
                      mode:
                        type: string
                        enum:
                          - inherit
                      filter_key:
                        anyOf:
                          - type: string
                            enum:
                              - time
                              - comparison
                              - cluster
                              - install
                              - product
                              - package
                              - region
                              - status
                          - type: string
                            pattern: ^var\.[a-z][a-z0-9_]{0,31}$
                    required:
                      - mode
                      - filter_key
                    additionalProperties: false
                  - type: object
                    properties:
                      mode:
                        type: string
                        enum:
                          - fixed
                      value: {}
                    required:
                      - mode
                      - value
                    additionalProperties: false
                  - type: object
                    properties:
                      mode:
                        type: string
                        enum:
                          - unbound
                    required:
                      - mode
                    additionalProperties: false
            visualization:
              type:
                - string
                - 'null'
              enum:
                - stat
                - sparkline
                - line
                - area
                - bar
                - donut
                - table
                - status_list
                - logs
                - json
                - null
            refresh_policy:
              oneOf:
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - on_load
                  required:
                    - mode
                  additionalProperties: false
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - manual
                  required:
                    - mode
                  additionalProperties: false
                - type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - interval
                    interval_seconds:
                      type: integer
                      minimum: 60
                      maximum: 86400
                  required:
                    - mode
                    - interval_seconds
                  additionalProperties: false
            display_type:
              type:
                - string
                - 'null'
              enum:
                - table
                - stat
                - json
                - logs
                - timeseries
                - null
              description: Controls how the snippet result is rendered in dashboard widgets
          required:
            - id
            - dashboard_id
            - title
            - position
            - col_span
            - height
            - drill_down
            - visualization_options
            - freshness_policy
            - created_at
            - updated_at
            - etag
            - widget_type
            - snippet_id
            - snippet_etag
            - input_bindings
            - visualization
            - refresh_policy
            - display_type
          additionalProperties: false
      x-platform-exact-union: true
    ApiErrorEntry:
      type: object
      properties:
        code:
          type: integer
          example: 7002
          description: Machine-readable error code
        message:
          type: string
          example: Resource not found
          description: Human-readable error message
        path:
          type: array
          items:
            type: string
          example:
            - body
            - name
          description: Field path that caused the error, when applicable
        metadata:
          type: object
          additionalProperties:
            type: string
      required:
        - code
        - message
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at
        https://akua.dev/developers/api-tokens

````