Skip to main content
GET
/
usage
cURL
# Get org-wide usage for this month
curl "https://api.arkhq.io/v1/usage" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get usage for last month
curl "https://api.arkhq.io/v1/usage?period=last_month" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "success": true,
  "data": {
    "period": {
      "start": "2024-01-01T00:00:00.000Z",
      "end": "2024-01-31T23:59:59.999Z"
    },
    "emails": {
      "sent": 50000,
      "delivered": 48500,
      "soft_failed": 500,
      "hard_failed": 300,
      "bounced": 500,
      "held": 200
    },
    "rates": {
      "delivery_rate": 0.97,
      "bounce_rate": 0.016
    },
    "tenants": {
      "total": 25,
      "active": 20,
      "withActivity": 18
    }
  },
  "meta": {
    "requestId": "req_abc123xyz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://arkhq.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Query Parameters

​
period
string
default:this_month

Time period for usage data.

Shortcuts: today, yesterday, this_week, last_week, this_month, last_month, last_7_days, last_30_days, last_90_days

Month format: 2024-01 (YYYY-MM)

Custom range: 2024-01-01..2024-01-15

​
timezone
string
default:UTC

Timezone for period calculations (IANA format)

Response

Org-wide usage summary

Org-wide usage summary response

​
success
boolean
required
​
data
object
required
​
meta
object
required