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

# Get workspace metrics



## OpenAPI

````yaml /openapi.json get /api/v1/workspaces/{workspace}/metrics
openapi: 3.0.3
info:
  title: ai-cmo.dev Services API
  version: 1.0.0
servers: []
security: []
paths:
  /api/v1/workspaces/{workspace}/metrics:
    get:
      summary: Get workspace metrics
      operationId: getWorkspaceMetrics
      parameters:
        - name: workspace
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9-]+$
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsOverview'
      security:
        - cookieAuth: []
        - bearerAuth:
            - metrics:read
components:
  schemas:
    MetricsOverview:
      type: object
      properties:
        scoreboard:
          type: object
          properties:
            brand:
              type: string
            date:
              type: string
            composite:
              type: object
              properties:
                value:
                  type: number
                  nullable: true
                ciLow:
                  type: number
                  nullable: true
                ciHigh:
                  type: number
                  nullable: true
                'n':
                  type: number
                  nullable: true
                entity:
                  type: string
                  nullable: true
                deltas:
                  type: object
                  properties:
                    previous:
                      type: number
                      nullable: true
                    7d:
                      type: number
                      nullable: true
                    28d:
                      type: number
                      nullable: true
                  required:
                    - previous
                    - 7d
                    - 28d
                  additionalProperties: false
              required:
                - value
                - ciLow
                - ciHigh
                - 'n'
                - entity
                - deltas
              additionalProperties: false
              nullable: true
            engines:
              type: array
              items:
                type: object
                properties:
                  engine:
                    type: string
                  metrics:
                    type: object
                    additionalProperties:
                      allOf:
                        - 754cf433-e30b-4c42-a5af-23080264e16a
                      nullable: true
                required:
                  - engine
                  - metrics
                additionalProperties: false
          required:
            - brand
            - date
            - composite
            - engines
          additionalProperties: false
          nullable: true
        latestRun:
          type: object
          properties:
            date:
              type: string
            preset:
              type: string
              nullable: true
            status:
              type: string
              nullable: true
            totalCostUsd:
              type: number
            runIds:
              type: array
              items:
                type: string
            enginesCovered:
              type: number
            responseCount:
              type: number
          required:
            - date
            - preset
            - status
            - totalCostUsd
            - runIds
            - enginesCovered
            - responseCount
          additionalProperties: false
          nullable: true
        recentRuns:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              preset:
                type: string
                nullable: true
              status:
                type: string
                nullable: true
              totalCostUsd:
                type: number
            required:
              - date
              - preset
              - status
              - totalCostUsd
            additionalProperties: false
        shareOfVoice:
          type: array
          items:
            type: object
            properties:
              entity:
                type: string
              value:
                type: number
                nullable: true
              ciLow:
                type: number
                nullable: true
              ciHigh:
                type: number
                nullable: true
              'n':
                type: number
                nullable: true
              isSelf:
                type: boolean
            required:
              - entity
              - value
              - ciLow
              - ciHigh
              - 'n'
              - isSelf
            additionalProperties: false
        topCitedDomains:
          type: array
          items:
            type: object
            properties:
              domain:
                type: string
              count:
                type: number
              taxonomy:
                type: string
                nullable: true
            required:
              - domain
              - count
              - taxonomy
            additionalProperties: false
        pendingRecommendations:
          type: object
          properties:
            proposed:
              type: number
            complianceFlagged:
              type: number
          required:
            - proposed
            - complianceFlagged
          additionalProperties: false
      required:
        - scoreboard
        - latestRun
        - recentRuns
        - shareOfVoice
        - topCitedDomains
        - pendingRecommendations
      additionalProperties: false
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: geo.session
      description: Signed HttpOnly browser session cookie
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: gp_live_<43 base64url characters>
      description: Workspace-bound machine API key

````