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

# Get the home dashboard

> This workspace’s dashboard: its stats, its layout, and the metrics it can build from

**Required scope:** `analytics.view`


## OpenAPI

````yaml /api-reference/openapi.json get /dashboard
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /dashboard:
    get:
      summary: Get the home dashboard
      description: >-
        This workspace’s dashboard: its stats, its layout, and the metrics it
        can build from
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  stats:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        title:
                          type: string
                        definition:
                          type: object
                          properties:
                            metricId:
                              type: string
                              minLength: 1
                              maxLength: 64
                            mode:
                              type: string
                              enum:
                                - value
                                - share_of
                                - per_day
                            compareMetricId:
                              type: string
                              minLength: 1
                              maxLength: 64
                            display:
                              type: string
                              enum:
                                - tile
                                - trend
                                - bars
                          required:
                            - metricId
                            - mode
                            - display
                        position:
                          type: integer
                        hidden:
                          type: boolean
                      required:
                        - id
                        - title
                        - definition
                        - position
                        - hidden
                  layout:
                    type: object
                    properties:
                      version:
                        type: number
                        enum:
                          - 1
                      ribbon:
                        type: object
                        properties:
                          order:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 64
                            maxItems: 40
                          hidden:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 64
                            maxItems: 40
                          sizes:
                            type: object
                            additionalProperties:
                              type: string
                              enum:
                                - small
                                - medium
                                - large
                                - full
                        required:
                          - order
                          - hidden
                      sections:
                        type: object
                        properties:
                          order:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 64
                            maxItems: 40
                          hidden:
                            type: array
                            items:
                              type: string
                              minLength: 1
                              maxLength: 64
                            maxItems: 40
                          sizes:
                            type: object
                            additionalProperties:
                              type: string
                              enum:
                                - small
                                - medium
                                - large
                                - full
                        required:
                          - order
                          - hidden
                    required:
                      - version
                      - ribbon
                      - sections
                  metrics:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        source:
                          type: string
                          enum:
                            - calls
                            - leads
                            - orders
                            - messages
                        label:
                          type: string
                        description:
                          type: string
                        unit:
                          type: string
                          enum:
                            - count
                            - percent
                            - currency
                            - duration
                            - ratio
                        endpoint:
                          type: string
                        path:
                          type: string
                        supports:
                          type: array
                          items:
                            type: string
                            enum:
                              - value
                              - share_of
                              - per_day
                      required:
                        - id
                        - source
                        - label
                        - description
                        - unit
                        - endpoint
                        - path
                        - supports
                required:
                  - stats
                  - layout
                  - metrics
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.