Usage Metrics
Get a Usage Metric by ID
Latest Live API
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
- Usage Metrics
- Usage Events
- Seat Metrics
- Seat Events
Version 2024-07-30
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Usage Metrics
Get a Usage Metric by ID
Get a Usage Metric by ID
GET
/
usage-metrics
/
{id}
curl --request GET \
--url https://eu.sequencehq.com/api/usage-metrics/{id} \
--header 'Authorization: <authorization>'
{
"id": "f092246c-6b90-4106-bcca-304ccf06bf45",
"sequenceAccountId": "ec1479a2-6ba1-421f-a7de-0853a20d17a1",
"name": "Total length of sent messages.",
"description": "Total length of sent messages.",
"metricType": "GROUPED",
"eventType": "message_sent",
"aggregationType": "COUNT",
"aggregationProperty": "message_length",
"groupingProperty": "channel",
"unit": "bytes",
"createdAt": "2022-06-28T16:47:00Z",
"deletedAt": "2022-06-28T16:47:00Z",
"propertyFilters": {
"channels": [
"text",
"email"
]
},
"caseSensitive": true,
"propertiesToNegate": [
"channels"
],
"parameters": [
{
"id": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"usageMetricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
"name": "myParam",
"type": "INTEGER",
"description": "My parameter",
"defaultValue": "10"
}
]
}
Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
Available options:
2024-07-30
Path Parameters
Unique ID
Response
200
application/json
OK
The response is of type object
.
curl --request GET \
--url https://eu.sequencehq.com/api/usage-metrics/{id} \
--header 'Authorization: <authorization>'
{
"id": "f092246c-6b90-4106-bcca-304ccf06bf45",
"sequenceAccountId": "ec1479a2-6ba1-421f-a7de-0853a20d17a1",
"name": "Total length of sent messages.",
"description": "Total length of sent messages.",
"metricType": "GROUPED",
"eventType": "message_sent",
"aggregationType": "COUNT",
"aggregationProperty": "message_length",
"groupingProperty": "channel",
"unit": "bytes",
"createdAt": "2022-06-28T16:47:00Z",
"deletedAt": "2022-06-28T16:47:00Z",
"propertyFilters": {
"channels": [
"text",
"email"
]
},
"caseSensitive": true,
"propertiesToNegate": [
"channels"
],
"parameters": [
{
"id": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"usageMetricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
"name": "myParam",
"type": "INTEGER",
"description": "My parameter",
"defaultValue": "10"
}
]
}