YourSendYourSend
Sign InGet Started →

GET /v1/usage

Retrieve your organization's message usage statistics, broken down by channel.

Get Usage

Returns aggregate usage counts for the specified time period, grouped by channel.

Query Parameters

ParameterTypeDefaultDescription
periodstringmonthTime period: "day", "week", or "month"

Response

Response
{
  "period": "month",
  "from": "2025-06-01T00:00:00Z",
  "to": "2025-06-15T12:00:00Z",
  "total": 4523,
  "by_channel": {
    "email": 3200,
    "sms": 1100,
    "voice": 150,
    "whatsapp": 73
  }
}

Example

cURL
curl https://api.yoursend.dev/v1/usage?period=week \
  -H "Authorization: Bearer ys_live_..."