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

# Get platform statistics

> Returns platform-wide statistics including user count, instance count, and message volume. Requires admin role.



## OpenAPI

````yaml openapi.json get /api/admin/stats
openapi: 3.0.0
info:
  title: Wappfy API
  description: >-
    WhatsApp API Platform — Manage instances, send messages, and build
    integrations.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wappfy.io
    description: Production
security: []
tags:
  - name: Instances
    description: Create, connect, and manage WhatsApp instances (WAHA or Cloud API)
  - name: Messages
    description: >-
      Send messages via WhatsApp (text, media, location, poll, contacts, and
      more)
  - name: Chats
    description: List chats, read messages, mark as seen, and manage typing indicators
  - name: Groups
    description: Create and manage WhatsApp groups, participants, and invite links
  - name: Contacts
    description: Look up contacts, check phone numbers, and fetch profile pictures
  - name: Labels
    description: Organize chats with WhatsApp Business labels
  - name: Channels
    description: Create and manage WhatsApp Channels (newsletters)
  - name: Status
    description: Publish text status/stories
  - name: Presence
    description: Set and get online/offline presence
  - name: Webhooks
    description: Configure webhook endpoints to receive real-time event notifications
  - name: Admin
    description: >-
      Platform administration — user management, statistics, and proxy
      monitoring (admin only)
paths:
  /api/admin/stats:
    get:
      tags:
        - Admin
      summary: Get platform statistics
      description: >-
        Returns platform-wide statistics including user count, instance count,
        and message volume. Requires admin role.
      operationId: AdminController_getStats
      parameters: []
      responses:
        '200':
          description: Platform statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminStatsResponseDto'
        '401':
          description: Missing or invalid authentication token
        '403':
          description: Insufficient permissions
        '500':
          description: Internal server error
      security:
        - bearer: []
components:
  schemas:
    AdminStatsResponseDto:
      type: object
      properties:
        totalUsers:
          type: number
          example: 150
          description: Total registered users
        totalInstances:
          type: number
          example: 320
          description: Total instances created
        activeInstances:
          type: number
          example: 185
          description: Currently connected instances
        totalMessages:
          type: number
          example: 45230
          description: Total messages processed
      required:
        - totalUsers
        - totalInstances
        - activeInstances
        - totalMessages
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````