Namespaces

Get namespace usage

Counts the messages the namespace sent and received in the window that count toward usage, by channel, with the same statuses as `GET /v1/organizations/usage`.

GET
/v1/namespaces/{id}/usage

Counts the messages the namespace sent and received in the window that count toward usage, by channel, with the same statuses as GET /v1/organizations/usage. A message counts toward the namespace it was sent or received in: that of the sender, mailbox, or key it used. The organization is billed for every namespace; read this to charge your own customer.

x-api-key<token>

In: header

Path Parameters

id*string
Match^ns_[0-9a-hjkmnp-tv-z]{16,24}$

Query Parameters

after?string|null
before?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/namespaces/string/usage"
{  "namespaceId": "string",  "periodStart": "string",  "periodEnd": "string",  "emailCount": 0,  "totalMessages": 0}

Related documentation