Skip to main content
GET
/
usage-metrics
/
{usageMetricId}
/
calculate
Calculate usage metric for customer and timeframe
curl --request GET \
  --url https://dev.seqhq.io/api/usage-metrics/{usageMetricId}/calculate \
  --header 'Authorization: <authorization>'
{
  "name": "total_messages_sent",
  "metricType": "GROUPED",
  "eventType": "message_sent",
  "aggregationType": "SUM",
  "eventCount": 5,
  "value": 150.035,
  "unit": "bytes",
  "minEventId": "0183d0f1-6b5a-74d4-9129-1f4b90191666",
  "maxEventId": "0183ea03-aca0-7019-b80d-6aacce344e92"
}

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
Example:

"bytes"

​
minEventId
string
Example:

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

​
maxEventId
string
Example:

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