Get Message Statistics

GET /api/v1/analytics/messages
Bearer auth

Retrieves aggregated statistics about messages within a specified date range for the user's organization.

Query parameters

  • start string

    Start date (RFC3339 format, e.g., 2023-01-01T00:00:00Z). Defaults to 30 days ago.

  • end string

    End date (RFC3339 format, e.g., 2023-01-31T23:59:59Z). Defaults to now.

Responses

  • 200 application/json

    Aggregated message statistics

    Additional properties are allowed.
  • 400 application/json

    Invalid date format

    Hide response attribute Show response attribute object
    • * string Additional properties
  • 401 application/json

    Unauthorized (JWT invalid/missing or Org ID not found)

    Hide response attribute Show response attribute object
    • * string Additional properties
  • 500 application/json

    Failed to get message statistics

    Hide response attribute Show response attribute object
    • * string Additional properties
GET /api/v1/analytics/messages 
curl \
 --request GET 'http://api.example.com/api/v1/analytics/messages' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{}
Response examples (400) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}
Response examples (401) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}
Response examples (500) 
{
  "additionalProperty1": "string",
  "additionalProperty2": "string"
}