Skip to main content
GET
Calculate usage metric for customer and timeframe

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

usageMetricId
string
required

Usage Metric ID

Query Parameters

customerAliases
string
required

Customer Aliases / internal IDs

periodStart
string
required

Billing period start

periodEnd
string
required

Billing period end (inclusive)

customParameters
string

Custom parameter values

Response

OK

name
string
required
Example:

"total_messages_sent"

metricType
enum<string>
required
Available options:
SIMPLE,
GROUPED
Example:

"GROUPED"

eventType
string
required
Example:

"message_sent"

aggregationType
enum<string>
required
Available options:
COUNT,
UNIQUE,
SUM,
CUSTOM
Example:

"COUNT"

eventCount
integer
required
Example:

5

value
number
required
Example:

150.035

unit
string | null
Example:

"bytes"

minEventId
string | null
Example:

"0183d0f1-6b5a-74d4-9129-1f4b90191666"

maxEventId
string | null
Example:

"0183ea03-aca0-7019-b80d-6aacce344e92"