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

# Get workspace metrics

> Integrate with the version 1 visibility and analytics endpoints.

Required scopes: `read`.


## OpenAPI

````yaml GET /api/v1/metrics/summary
openapi: 3.1.1
info:
  title: chatobserver public API
  version: '2026-09-09'
  description: >-
    Track AI visibility, manage prompts, inspect collected answers and
    citations, and integrate workspace data with your own tools. Visibility
    endpoints use workspace API keys. Data endpoints use scoped service-account
    keys; spreadsheet client endpoints use authorised client sessions. See the
    authentication guide for each credential type.
  contact:
    name: chatobserver support
    url: https://chatobserver.com/contact
    email: support@chatobserver.com
servers:
  - url: https://app.chatobserver.com
    description: Production API
security:
  - WorkspaceKey: []
  - BearerKey: []
tags:
  - name: Workspace
    description: Validate access and list the workspace project and available platforms.
  - name: Prompts
    description: Create, schedule, organise, activate and retrieve tracked prompts.
  - name: Answers
    description: Retrieve collected AI answers, their analysis and visibility trends.
  - name: Brands
    description: Manage brands and compare their visibility in AI answers.
  - name: Sources and citations
    description: Analyse cited domains, pages and ownership across answers.
  - name: Visitor analytics
    description: Read website visitor and crawler analytics for the workspace.
  - name: Content opportunities
    description: Retrieve content-gap findings and recommendations for tracked prompts.
  - name: Usage
    description: Read workspace consumption and allowance summaries.
  - name: Data connections
    description: Discover authorised connections, source accounts and connector catalogues.
  - name: Data queries
    description: >-
      Create versioned queries, publish definitions and inspect integration
      contracts.
  - name: Data operations
    description: >-
      Execute, validate, cancel and inspect operations and page through result
      rows.
  - name: Data delivery
    description: Manage schedules, transfers, destinations and import workflows.
  - name: Data definitions
    description: Manage reusable definitions and their immutable versions.
  - name: Data webhooks
    description: >-
      Configure event delivery, inspect deliveries, replay events and rotate
      secrets.
  - name: Client authorisation
    description: Authorise spreadsheet clients using a user-approved challenge exchange.
  - name: Spreadsheet clients
    description: >-
      Access document-bound client sessions, queries, schedules, bindings and
      write claims.
  - name: AI visibility audits
    description: Create website visibility audits and retrieve their report links.
  - name: Version 1
    description: Integrate with the version 1 visibility and analytics endpoints.
paths:
  /api/v1/metrics/summary:
    get:
      tags:
        - Version 1
      summary: Get workspace metrics
      description: >-
        Integrate with the version 1 visibility and analytics endpoints.
        Required scopes: `read`.
      operationId: getV1MetricsSummary
      parameters:
        - name: sourcesWindowDays
          in: query
          required: false
          schema:
            type: number
            minimum: 1
            maximum: 365
            default: 30
        - name: visitorLookback
          in: query
          required: false
          schema:
            type: number
            minimum: 1
            maximum: 30
            default: 7
        - name: usageAsOf
          in: query
          required: false
          schema:
            type: string
            format: date-time
        - name: runsSinceDays
          in: query
          required: false
          schema:
            type: number
            minimum: 1
            maximum: 365
        - name: includeVisitor
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
                const: false
              - type: boolean
                const: true
            default: true
        - name: includeUsage
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
                const: false
              - type: boolean
                const: true
            default: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getV1MetricsSummaryResponse200'
        default:
          description: >-
            Request failed. Inspect the error code and request identifier; retry
            only when the failure is retryable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    getV1MetricsSummaryResponse200:
      type: object
      properties:
        data:
          type: object
          properties:
            promptRuns:
              type: object
              properties:
                total:
                  type: number
                succeeded:
                  type: number
                failed:
                  type: number
                running:
                  type: number
                queued:
                  type: number
                lastCreatedAt:
                  anyOf:
                    - type: 'null'
                    - type: string
                lastCompletedAt:
                  anyOf:
                    - type: 'null'
                    - type: string
              required:
                - total
                - succeeded
                - failed
                - running
                - queued
                - lastCreatedAt
                - lastCompletedAt
            sources:
              type: object
              properties:
                mentionCount:
                  type: number
                citationCount:
                  type: number
                linkCount:
                  type: number
                uniqueDomains:
                  type: number
                lastCaptureAt:
                  anyOf:
                    - type: 'null'
                    - type: string
              required:
                - mentionCount
                - citationCount
                - linkCount
                - uniqueDomains
                - lastCaptureAt
            usage:
              anyOf:
                - type: 'null'
                - type: object
                  properties:
                    tier:
                      type: string
                    prompts:
                      type: object
                      properties:
                        used:
                          type: number
                        limit:
                          anyOf:
                            - type: 'null'
                            - type: number
                        remaining:
                          anyOf:
                            - type: 'null'
                            - type: number
                      required:
                        - used
                        - limit
                        - remaining
                    analysis:
                      type: object
                      properties:
                        status:
                          enum:
                            - active
                            - disabled
                          type: string
                        used:
                          type: number
                        limit:
                          anyOf:
                            - type: 'null'
                            - type: number
                        remaining:
                          anyOf:
                            - type: 'null'
                            - type: number
                        periodStart:
                          type: string
                        periodEnd:
                          type: string
                      required:
                        - status
                        - used
                        - limit
                        - remaining
                        - periodStart
                        - periodEnd
                  required:
                    - tier
                    - prompts
                    - analysis
            visitorAnalytics:
              type: object
              properties:
                metrics:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        enum:
                          - chatgpt.com
                          - claude.ai
                          - copilot.microsoft.com
                          - gemini.google.com
                          - perplexity.ai
                        type: string
                      label:
                        type: string
                      count:
                        type: number
                    required:
                      - key
                      - label
                      - count
                hasData:
                  anyOf:
                    - type: boolean
                      const: false
                    - type: boolean
                      const: true
                lastEventAt:
                  anyOf:
                    - type: 'null'
                    - type: string
              required:
                - metrics
                - hasData
                - lastEventAt
          required:
            - promptRuns
            - sources
            - usage
            - visitorAnalytics
        generatedAt:
          type: string
      required:
        - data
        - generatedAt
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
        requestId:
          type: string
      required:
        - error
        - requestId
  securitySchemes:
    WorkspaceKey:
      type: apiKey
      in: header
      name: x-chatobserver-key
      description: >-
        A workspace API key. Data endpoints require a service-account key with
        the specified scopes.
    BearerKey:
      type: http
      scheme: bearer
      description: The workspace or service-account API key as a bearer token.

````