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

# Admin SMS Stats

> Get SMS/message statistics for a tenant with optional filters



## OpenAPI

````yaml https://api.voxo.co/v2/docs/openapi.json post /v2/admin/reporting/messages/stats
openapi: 3.1.0
info:
  title: VOXO API
  description: VOXO Communication Platform API
  version: 2.0.0
servers:
  - url: https://api.voxo.co
security:
  - bearerAuth: []
paths:
  /v2/admin/reporting/messages/stats:
    post:
      tags:
        - Reporting - Messages
      summary: Admin SMS Stats
      description: Get SMS/message statistics for a tenant with optional filters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tenantId:
                  type: number
                  exclusiveMinimum: 0
                  description: Tenant ID
                startDate:
                  type: string
                  description: Start date for the report period
                endDate:
                  type: string
                  description: End date for the report period
                distribution:
                  description: >-
                    Time distribution grouping (daily, weekly, monthly, or
                    totals)
                  anyOf:
                    - type: string
                      enum:
                        - weekly
                    - type: string
                      enum:
                        - daily
                    - type: string
                      enum:
                        - monthly
                    - type: string
                      enum:
                        - totals
                users:
                  description: Filter by user peer names, or 'ALL' for all users
                  anyOf:
                    - type: array
                      items:
                        type: string
                    - type: string
                      enum:
                        - ALL
                groups:
                  description: Filter by groups (queue, huntlist, or branch)
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        anyOf:
                          - type: string
                            enum:
                              - queue
                          - type: string
                            enum:
                              - huntlist
                          - type: string
                            enum:
                              - branch
                      id:
                        type: number
                        exclusiveMinimum: 0
                    required:
                      - type
                      - id
                phoneNumber:
                  description: Filter by phone numbers
                  type: array
                  items:
                    type: string
                direction:
                  description: Message direction filter (inbound or outbound)
                  anyOf:
                    - type: string
                      enum:
                        - inbound
                    - type: string
                      enum:
                        - outbound
              required:
                - tenantId
                - startDate
                - endDate
              additionalProperties: false
      responses:
        '200':
          description: SMS statistics or export acknowledgement
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      tenantId:
                        type: number
                        description: Tenant ID
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            inbound:
                              type: number
                              description: Number of inbound messages
                            outbound:
                              type: number
                              description: Number of outbound messages
                            total:
                              type: number
                              description: Total messages
                            date:
                              description: Distribution date
                              type: string
                            distribution:
                              description: Time distribution label
                              type: string
                            peerName:
                              description: User peer name
                              type: string
                            name:
                              description: User display name
                              type: string
                          required:
                            - inbound
                            - outbound
                            - total
                          additionalProperties: false
                        description: SMS statistics results
                    required:
                      - tenantId
                      - results
                    additionalProperties: false
                    description: SMS statistics
                  - type: object
                    properties:
                      message:
                        type: string
                        description: Status message
                      code:
                        type: number
                        description: Status code
                    required:
                      - message
                      - code
                    additionalProperties: false
                    description: Export acknowledgement
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````