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

# Get Message Statistics

> Retrieve aggregated statistics about messages



## OpenAPI

````yaml https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/realtime.yaml get /api/realtime/messages/stats
openapi: 3.0.3
info:
  title: Insforge Realtime API
  version: 1.0.0
  description: >-
    Realtime channel management, message history, permissions, and retention
    API. Live pub/sub uses Socket.IO.
servers: []
security: []
tags:
  - name: Channels
    description: Configure realtime channel patterns, webhooks, and availability.
  - name: Messages
    description: Inspect realtime message history and delivery stats.
  - name: Permissions
    description: Manage helper endpoints for realtime RLS examples.
  - name: Configuration
    description: Manage realtime retention settings.
paths:
  /api/realtime/messages/stats:
    get:
      tags:
        - Messages
      summary: Get Message Statistics
      description: Retrieve aggregated statistics about messages
      parameters:
        - name: channelId
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Filter stats by channel ID
          example: 550e8400-e29b-41d4-a716-446655440000
        - name: since
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter stats since this timestamp
          example: '2024-01-01T00:00:00Z'
      responses:
        '200':
          description: Message statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageStats'
              example:
                totalMessages: 1250
                whDeliveryRate: 0.98
                topEvents:
                  - eventName: order.created
                    count: 450
                  - eventName: order.updated
                    count: 380
                  - eventName: order.completed
                    count: 220
                retentionDays: null
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: INVALID_INPUT
                message: 'since: Invalid datetime'
                statusCode: 400
      security:
        - bearerAuth: []
        - apiKey: []
components:
  schemas:
    MessageStats:
      type: object
      required:
        - totalMessages
        - whDeliveryRate
        - topEvents
        - retentionDays
      properties:
        totalMessages:
          type: integer
          minimum: 0
          description: Total number of messages
          example: 1250
        whDeliveryRate:
          type: number
          minimum: 0
          maximum: 1
          description: Webhook delivery success rate (0-1)
          example: 0.98
        topEvents:
          type: array
          description: Most frequent event types
          items:
            type: object
            required:
              - eventName
              - count
            properties:
              eventName:
                type: string
                description: Name of the event
                example: order.created
              count:
                type: integer
                minimum: 0
                description: Number of occurrences
                example: 450
        retentionDays:
          type: integer
          nullable: true
          minimum: 1
          description: >-
            Number of days messages are retained. Null means messages are kept
            indefinitely.
          example: null
    ErrorResponse:
      type: object
      required:
        - error
        - message
        - statusCode
      properties:
        error:
          type: string
          description: Error code for programmatic handling
          example: INVALID_INPUT
        message:
          type: string
          description: Human-readable error message
          example: Invalid request
        statusCode:
          type: integer
          description: HTTP status code
          example: 400
        nextActions:
          type: string
          description: Suggested action to resolve the error
          example: Check your request parameters
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key

````