Skip to main content

Try the live demo!

Search

Get Overview Message Volume

Requires the `reports:manage` permission.

GET /api/v1/reports/overview/messages

Requires the reports:manage permission.

Authentication

Use an agent API key and secret.

Parameters

All parameters are query parameters. All parameters are optional.

Name Type Description
days integer Number of past days to include. 0 means today only. Values outside 0-365 are clamped. default: 0 minimum: 0 maximum: 365

Responses

200

Report retrieved successfully

Content type: application/json.

All fields are optional.

Field Type Description
status string example: "success"
data object
data.total_messages integer example: 120
data.incoming_messages integer example: 70
data.outgoing_messages integer example: 50
data.messages_per_conversation number example: 4.5

401

Unauthorized

Content type: application/json.

All fields are optional.

Field Type Description
status string example: "error"
message string Error message example: "Invalid request"
data unspecified Additional error data nullable: true
error_type string (enum) enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"]

403

Permission denied

Content type: application/json.

Response fields match the 401 response.

500

Internal server error

Content type: application/json.

Response fields match the 401 response.

Specification

Download the complete OpenAPI specification.

OpenAPI definition for this endpoint
openapi: 3.0.0
info:
  title: libredesk API
  description: >-
    REST API documentation for libredesk helpdesk system.


    ## Authentication


    The libredesk API supports two authentication methods:


    ### 1. Basic Authentication

    Use your API key and secret with Basic authentication:

    ```

    Authorization: Basic <base64_encoded_api_key:api_secret>

    ```


    ### 2. Token Authentication  

    Use your API key and secret with token authentication:

    ```

    Authorization: token api_key:api_secret

    ```


    To obtain API credentials, generate them from your agent profile in the
    libredesk dashboard.
  version: 1.0.0
servers:
  - url: http://localhost:8080
    description: Local development server
security:
  - basicAuth: []
  - tokenAuth: []
paths:
  /api/v1/reports/overview/messages:
    get:
      tags:
        - Reports
      summary: Get Overview Message Volume
      description: Requires the `reports:manage` permission.
      operationId: handleOverviewMessageVolume
      parameters:
        - name: days
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            maximum: 365
            default: 0
          description: >-
            Number of past days to include. 0 means today only. Values outside
            0-365 are clamped.
      responses:
        '200':
          description: Report retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportOverviewMessageVolumeResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - basicAuth: []
        - tokenAuth: []
components:
  schemas:
    ReportOverviewMessageVolumeResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        data:
          $ref: '#/components/schemas/ReportOverviewMessageVolume'
    ErrorResponse:
      type: object
      description: Error response format
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          description: Error message
          example: Invalid request
        data:
          nullable: true
          description: Additional error data
        error_type:
          type: string
          enum:
            - GeneralException
            - PermissionException
            - InputException
            - DataException
            - NetworkException
            - NotFoundException
            - ConflictException
            - UnauthorizedException
            - RateLimitException
    ReportOverviewMessageVolume:
      type: object
      properties:
        total_messages:
          type: integer
          example: 120
        incoming_messages:
          type: integer
          example: 70
        outgoing_messages:
          type: integer
          example: 50
        messages_per_conversation:
          type: number
          example: 4.5
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication using base64 encoded API key and secret. Format:
        `Authorization: Basic <base64(api_key:api_secret)>`
    tokenAuth:
      type: apiKey
      name: Authorization
      in: header
      description: >-
        Token authentication using API key and secret. Format: `Authorization:
        token api_key:api_secret`

Was this article helpful?