Skip to main content
GET
/
reports
/
usage
Get usage report
curl --request GET \
  --url https://api.hixbe.com/sms/reports/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Hixbe-Version: <hixbe-version>'
{
  "period": "monthly",
  "start_date": "2026-01-01",
  "end_date": "2026-01-31",
  "messages": {
    "total": 12450,
    "delivered": 12100,
    "failed": 350,
    "delivery_rate": 97.19
  },
  "by_route": {
    "otp": 3200,
    "transactional": 7500,
    "promotional": 1750
  },
  "total_cost": 6225.5,
  "currency": "BDT"
}
Retrieve detailed usage statistics and analytics for a specific period. Metrics Included:
  • Total messages sent
  • Delivery rates
  • Breakdown by route
  • Cost analysis
  • Failure reasons

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. Format: Authorization: Bearer sk_live_xxxxx

Headers

​
Hixbe-Version
string
default:2026-01-01
required

API version in YYYY-MM-DD format. Using the latest version ensures access to newest features.

Pattern: ^\d{4}-\d{2}-\d{2}$

Query Parameters

​
period
enum<string>
required

Report period

Available options:
daily,
weekly,
monthly,
yearly
​
start_date
string<date>

Period start date (YYYY-MM-DD)

​
end_date
string<date>

Period end date (YYYY-MM-DD)

Response

Usage report

Usage statistics and analytics

​
period
enum<string>
required

Report period

Available options:
daily,
weekly,
monthly,
yearly
Example:

"monthly"

​
start_date
string<date>
required

Period start date

Example:

"2026-01-01"

​
end_date
string<date>
required

Period end date

Example:

"2026-01-31"

​
messages
object
required

Message statistics by status

​
by_route
object

Statistics broken down by route

​
total_cost
number

Total cost for the period

Example:

6225.5

​
currency
string

Currency code

Example:

"BDT"