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

# Get Workspace Overview KPIs

> Retrieve aggregate performance metrics across all campaigns, including lifetime DMs, follow-ups, replies, and response rates.



## OpenAPI

````yaml GET /api/v1/analytics/overview
openapi: 3.1.0
info:
  title: Wave Public API
  description: >-


    ### Authentication

    All public endpoints require a valid API Key provided via header:

    * **Authorization:** `Bearer wave_live_...`


    ### Access Control

    API access is tied directly to your Wave subscription. An active or trialing
    subscription is required. Inactive subscriptions will receive a `403
    Forbidden` error.


    ### Rate Limiting

    Requests are limited per API key using a 60-second sliding window. Tiers:
    **Paid** Subscription get 60 requests/min, **Trial** Subscription get 30
    requests/min. Every authenticated response carries `X-RateLimit-Limit`,
    `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers. Exceeding the
    limit returns `429 Too Many Requests` with a `Retry-After` header indicating
    the seconds to wait.
                    
  license:
    name: Proprietary
    url: https://app.usewave.co/
  version: 1.0.0
servers:
  - url: https://api.usewave.co
security: []
paths:
  /api/v1/analytics/overview:
    get:
      tags:
        - Analytics
      summary: Get Workspace Overview KPIs
      description: |-
        Retrieves high-level workspace performance rollup across all campaigns:
        - Total campaigns count
        - Total initial DMs sent
        - Total follow-ups sent
        - Total replies received
        - Aggregate reply rate percentage
      operationId: get_workspace_analytics_overview
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicWorkspaceOverviewResponse'
        '400':
          description: Bad Request - Invalid parameters or input payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageResponse'
        '401':
          description: Unauthorized - Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageResponse'
        '403':
          description: Forbidden - Active subscription required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageResponse'
        '404':
          description: >-
            Not Found - The resource does not exist or belongs to another
            account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageResponse'
        '422':
          description: Unprocessable Entity - Schema validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageResponse'
        '429':
          description: Rate Limit Exceeded - Request quota exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageResponse'
        '500':
          description: Internal Server Error - Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    PublicWorkspaceOverviewResponse:
      properties:
        total_campaigns:
          type: integer
          title: Total Campaigns
          description: Total number of campaigns in workspace
          default: 0
        total_dms_sent:
          type: integer
          title: Total Dms Sent
          description: Total initial DMs sent across all campaigns
          default: 0
        total_follow_ups_sent:
          type: integer
          title: Total Follow Ups Sent
          description: Total follow-up messages sent across all campaigns
          default: 0
        total_replies_received:
          type: integer
          title: Total Replies Received
          description: Total DM replies received across all campaigns
          default: 0
        reply_rate:
          type: number
          title: Reply Rate
          description: Overall reply percentage (0-100)
          default: 0
      type: object
      title: PublicWorkspaceOverviewResponse
      description: Workspace-level KPI rollup across all campaigns.
    ErrorMessageResponse:
      properties:
        status:
          type: integer
          title: Status
          description: HTTP status code
          example: 400
        error:
          type: string
          title: Error
          description: HTTP status phrase or category
          example: Bad Request
        message:
          type: string
          title: Message
          description: Human-readable explanation of the error
          example: Invalid request parameters.
        details:
          anyOf:
            - {}
            - type: 'null'
          title: Details
          description: Granular validation failure details or contextual information
      type: object
      required:
        - status
        - error
        - message
      title: ErrorMessageResponse
      description: Standardized public error response structure modeled after Dripify.
  securitySchemes:
    HTTPBearer:
      type: http
      description: 'Enter your API key: `wave_live_<token>`'
      scheme: bearer

````