Returns email usage statistics for all tenants in your organization. Results are paginated with page-based navigation.
Jobs to be done:
Sorting options:
sent, -sent - Sort by emails sent (ascending/descending)delivered, -delivered - Sort by emails deliveredbounce_rate, -bounce_rate - Sort by bounce ratetenant_name, -tenant_name - Sort alphabetically by tenant nameFiltering:
status - Filter by tenant status (active, suspended, archived)minSent - Only include tenants with at least N emails sentAuto-pagination: SDKs support iterating over all pages automatically.
Use your API key from arkhq.io/org/credentials
Authorization: Bearer YOUR_API_KEYTime period for usage data. Defaults to current month.
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
Page number (1-indexed)
x >= 1Results per page (max 100)
1 <= x <= 100Sort order for results. Prefix with - for descending order.
sent, -sent, delivered, -delivered, bounce_rate, -bounce_rate, delivery_rate, -delivery_rate, tenant_name, -tenant_name Filter by tenant status
active, suspended, archived Only include tenants with at least this many emails sent
x >= 0Timezone for period calculations (IANA format). Defaults to UTC.
Paginated tenant usage statistics
Paginated tenant usage list (Stainless SDK compatible)
List of tenant usage records
Current page number (1-indexed)
1
Items per page
50
Total number of tenants
150
Total number of pages
3
Time period for usage data