Distributor API v1Usage
Get aggregated usage for a single partner's organizations
Returns aggregated usage across all customer organizations that belong to the specified partner (MSP), plus a per-organization breakdown.
Authorization
DistributorApiKey AuthorizationBearer <token>
Long-lived distributor API key scoped to a channel partner on the shared smao instance.
In: header
Path Parameters
partnerId*string
MongoDB ObjectId of the partner (MSP).
Match
^[a-fA-F0-9]{24}$Query Parameters
from*string
Start date in YYYY-MM-DD format, inclusive.
Format
dateto*string
End date in YYYY-MM-DD format, inclusive.
Format
dateResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/partners/665abc123def456789012345/usage?from=2019-08-24&to=2019-08-24"{ "status": "success", "period": { "from": "2019-08-24", "to": "2019-08-24" }, "totals": { "calls": { "count": 0, "minutes": 0 }, "forwards": { "count": 0, "minutes": 0 }, "assistants": 0, "sms": { "count": 0, "segments": 0 }, "whatsapp": 0 }, "organizationCount": 0, "organizations": [ { "id": "69c175970f3e28310926a1aa", "name": "string", "externalCustomerId": "string", "usage": { "calls": { "count": 0, "minutes": 0 }, "forwards": { "count": 0, "minutes": 0 }, "assistants": 0, "sms": { "count": 0, "segments": 0 }, "whatsapp": 0 } } ]}