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

# Get server health metrics

> Memory of the process and of its container (cgroup v2, then v1), CPU time, size of statics/media and storages (walk cached for a minute), free space on the volume, the session store and how many devices are registered, logged in and connected. Requires no device. Nullable fields are unknown on the current platform (non-Linux) or unlimited (container memory limit). Folder usage is best effort: missing or unreadable entries are omitted, and symlink targets are not traversed. Container metrics use the standard /sys/fs/cgroup mount and are null when unavailable. Uptime includes process initialization.




## OpenAPI

````yaml /openapi.yml get /app/metrics
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: |
    This API is used for sending whatsapp via API.

    The web dashboard is a separate project (gowa-ui); the server downloads its
    latest release asset and serves it at `/` (or returns a JSON banner when
    APP_UI_ENABLED=false).

    Device scoping:
    - Send `X-Device-Id` on all device-scoped REST calls.
    - WebSocket: connect to `/ws?device_id=<id>`.
    - WebSocket auth (when basic auth is enabled): browsers cannot set an
      Authorization header on WebSocket connections, so also pass
      `&authorization=<base64(user:pass)>` in the query string. Use TLS in
      production since the credential is visible in the URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Initial Connection to Whatsapp server
  - name: device
    description: Device management for multi-device support
  - name: user
    description: Getting information
  - name: send
    description: Send Message (Text/Image/File/Video).
  - name: message
    description: Message manipulation (revoke/react/update).
  - name: call
    description: Call management (reject incoming calls)
  - name: chat
    description: Chat conversations and messaging
  - name: group
    description: Group setting
  - name: newsletter
    description: newsletter setting
  - name: chatwoot
    description: Chatwoot integration for customer support
paths:
  /app/metrics:
    get:
      tags:
        - app
      summary: Get server health metrics
      description: >
        Memory of the process and of its container (cgroup v2, then v1), CPU
        time, size of statics/media and storages (walk cached for a minute),
        free space on the volume, the session store and how many devices are
        registered, logged in and connected. Requires no device. Nullable fields
        are unknown on the current platform (non-Linux) or unlimited (container
        memory limit). Folder usage is best effort: missing or unreadable
        entries are omitted, and symlink targets are not traversed. Container
        metrics use the standard /sys/fs/cgroup mount and are null when
        unavailable. Uptime includes process initialization.
      operationId: appMetrics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                  code:
                    type: string
                    example: SUCCESS
                  message:
                    type: string
                    example: Fetch app metrics success
                  results:
                    type: object
                    properties:
                      version:
                        type: string
                        example: v9.6.0
                      session_store:
                        type: string
                        enum:
                          - sqlite
                          - postgres
                      devices:
                        type: object
                        properties:
                          total:
                            type: integer
                            example: 5
                          logged_in:
                            type: integer
                            example: 3
                          connected:
                            type: integer
                            example: 3
                      system:
                        type: object
                        properties:
                          started_at:
                            type: string
                            format: date-time
                          uptime_seconds:
                            type: integer
                            example: 3600
                          go_version:
                            type: string
                            example: go1.26.9
                          cpu_seconds:
                            type: number
                            nullable: true
                            example: 17.9
                          memory:
                            type: object
                            properties:
                              heap_alloc_bytes:
                                type: integer
                                format: int64
                              runtime_sys_bytes:
                                type: integer
                                format: int64
                              process_rss_bytes:
                                type: integer
                                format: int64
                                nullable: true
                              container_bytes:
                                type: integer
                                format: int64
                                nullable: true
                              container_limit_bytes:
                                type: integer
                                format: int64
                                nullable: true
                              goroutines:
                                type: integer
                              gc_cycles:
                                type: integer
                          folders:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                bytes:
                                  type: integer
                                  format: int64
                                files:
                                  type: integer
                                  format: int64
                          filesystem:
                            type: object
                            properties:
                              total_bytes:
                                type: integer
                                format: int64
                                nullable: true
                              free_bytes:
                                type: integer
                                format: int64
                                nullable: true
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.