Metrics
Get an UsageMetric by ID
Get an UsageMetric by ID
GET
/
usage-metrics
/
{id}
Header
Path
curl --request GET \
--url https://eu.sequencehq.com/api/usage-metrics/{id} \
--header 'Authorization: <authorization>'
{
"aggregationProperty": "message_length",
"aggregationType": "COUNT",
"caseSensitive": true,
"createdAt": "2022-06-28T16:47:00Z",
"deletedAt": "2022-06-28T16:47:00Z",
"description": "Total length of sent messages.",
"eventType": "message_sent",
"groupingProperty": "channel",
"id": "f092246c-6b90-4106-bcca-304ccf06bf45",
"metricType": "GROUPED",
"name": "Total length of sent messages.",
"propertyFilters": {
"channels": [
"text",
"email"
]
},
"sequenceAccountId": "ec1479a2-6ba1-421f-a7de-0853a20d17a1",
"unit": "bytes"
}
Headers
Authorizationrequired
string
Your API credentials. Eg. Basic {credentials}
.
Path Parameters
idrequired
string
Unique ID
Response
200 - application/json
aggregationProperty
string
aggregationTyperequired
enum<string>
Available options:
COUNT
, UNIQUE
, SUM
caseSensitive
boolean
createdAt
string
deletedAt
string
description
string
eventTyperequired
string
groupingProperty
string
idrequired
string
metricTyperequired
enum<string>
Available options:
SIMPLE
, GROUPED
namerequired
string
propertyFiltersrequired
object
sequenceAccountIdrequired
string
unit
string
curl --request GET \
--url https://eu.sequencehq.com/api/usage-metrics/{id} \
--header 'Authorization: <authorization>'
{
"aggregationProperty": "message_length",
"aggregationType": "COUNT",
"caseSensitive": true,
"createdAt": "2022-06-28T16:47:00Z",
"deletedAt": "2022-06-28T16:47:00Z",
"description": "Total length of sent messages.",
"eventType": "message_sent",
"groupingProperty": "channel",
"id": "f092246c-6b90-4106-bcca-304ccf06bf45",
"metricType": "GROUPED",
"name": "Total length of sent messages.",
"propertyFilters": {
"channels": [
"text",
"email"
]
},
"sequenceAccountId": "ec1479a2-6ba1-421f-a7de-0853a20d17a1",
"unit": "bytes"
}