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

# Retrieve analytics

> Reads sanitized workspace analytics aggregates for agents, surveys, widget activity, and customer feedback. Provider/model/cost/debug internals are excluded.



## OpenAPI

````yaml /openapi.json get /api/v1/analytics
openapi: 3.1.0
info:
  title: Woes REST API
  summary: >-
    Public REST API for Woes workspace conversations, issues, clients, agents,
    sources, definitions, usage, and analytics.
  description: >-
    Use workspace API keys to work with Woes support conversations, messages,
    issues, client account aggregates, public agent metadata, API context
    sources, workspace definitions, usage meters, and sanitized analytics from
    server-side integrations.
  version: '2026-06-29'
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://woes.dev
    description: Production
security:
  - workspaceApiKey: []
tags:
  - name: Conversations
    description: Create, read, update, and message support conversations.
  - name: Issues
    description: Create, read, and update support issues.
  - name: Clients
    description: Read client account aggregates derived from workspace conversations.
  - name: Agents
    description: Read named support agent metadata and public widget keys.
  - name: Sources
    description: Create, inspect, update, delete, and rescan API context sources.
  - name: Definitions
    description: Read workspace tags, statuses, priorities, and custom field definitions.
  - name: Usage
    description: Read current-month public API and live API check usage.
  - name: Analytics
    description: Read sanitized workspace analytics aggregates.
paths:
  /api/v1/analytics:
    get:
      tags:
        - Analytics
      summary: Retrieve analytics
      description: >-
        Reads sanitized workspace analytics aggregates for agents, surveys,
        widget activity, and customer feedback. Provider/model/cost/debug
        internals are excluded.
      operationId: retrieveAnalytics
      parameters:
        - $ref: '#/components/parameters/AnalyticsLimit'
      responses:
        '200':
          description: Workspace analytics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsResponse'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    AnalyticsLimit:
      name: limit
      in: query
      required: false
      description: Maximum number of recent rows sampled per analytics area.
      schema:
        type: integer
        minimum: 1
        maximum: 2000
        default: 500
  schemas:
    AnalyticsResponse:
      type: object
      properties:
        object:
          type: string
          const: analytics
        window:
          type: integer
        analytics:
          type: object
          properties:
            agents:
              type: object
              additionalProperties: true
            surveys:
              type: object
              additionalProperties: true
            widget:
              type: object
              additionalProperties: true
            feedback:
              type: object
              additionalProperties: true
          additionalProperties: false
      additionalProperties: false
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - code
        - error
      properties:
        code:
          type: string
        error:
          type: string
  responses:
    InvalidRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidRequest:
              value:
                code: invalid_request
                error: Request body is invalid.
    Unauthorized:
      description: Missing, unknown, revoked, or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                code: unauthorized
                error: A valid workspace API key is required.
    InsufficientScope:
      description: API key does not include the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientScope:
              value:
                code: insufficient_scope
                error: This API key is missing the required scope.
    RateLimited:
      description: Too many API requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                code: rate_limited
                error: Too many API requests. Slow down and try again shortly.
    InternalError:
      description: Unexpected API failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              value:
                code: internal_error
                error: The API request could not be completed.
  securitySchemes:
    workspaceApiKey:
      type: http
      scheme: bearer
      description: >-
        Workspace API key that starts with woesk_. Paste your own key into the
        docs playground; never expose it in browser code.
      x-default: woesk_your_api_key_here

````