POST
/
usage-metrics
Create a new Usage Metric
curl --request POST \
  --url https://eu.sequencehq.com/api/usage-metrics \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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",
  "deletedAt": "2022-06-28T16:47:00Z",
  "propertyFilters": {
    "channels": [
      "text",
      "email"
    ]
  },
  "caseSensitive": true,
  "propertiesToNegate": [
    "channels"
  ]
}'
{
  "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

​
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

Body

application/json
​
name
string
required

Human-readable name for this metric, which should be unique

Example:

"Total length of sent messages."

​
metricType
enum<string>
required

Type of metric (simple or grouped)

Available options:
SIMPLE,
GROUPED
Example:

"GROUPED"

​
eventType
string
required

The eventType of the Usage Event to be aggregated

Example:

"message_sent"

​
aggregationType
enum<string>
required

Type of aggregation to perform

Available options:
COUNT,
UNIQUE,
SUM,
CUSTOM
Example:

"COUNT"

​
description
string

Description for this metric

Example:

"Total length of sent messages."

​
aggregationProperty
string

Property within the event to aggregate

Example:

"message_length"

​
groupingProperty
string

Property within the event to group results by

Example:

"channel"

​
unit
string

Human-readable unit of the aggregated metric, eg. API calls)

Example:

"bytes"

​
deletedAt
string

Created at

Example:

"2022-06-28T16:47:00Z"

​
propertyFilters
object

propertyFilters

​
caseSensitive
boolean

caseSensitive

Example:

true

​
propertiesToNegate
string[]

propertiesToNegate

Example:
["channels"]

Response

Created

​
id
string
required

Unique ID

Example:

"f092246c-6b90-4106-bcca-304ccf06bf45"

​
sequenceAccountId
string
required

Sequence Account ID

Example:

"ec1479a2-6ba1-421f-a7de-0853a20d17a1"

​
name
string
required

Human-readable name for this metric, which should be unique

Example:

"Total length of sent messages."

​
metricType
enum<string>
required

Type of metric (simple or grouped)

Available options:
SIMPLE,
GROUPED
Example:

"GROUPED"

​
eventType
string
required

The eventType of the Usage Event to be aggregated

Example:

"message_sent"

​
aggregationType
enum<string>
required

Type of aggregation to perform

Available options:
COUNT,
UNIQUE,
SUM,
CUSTOM
Example:

"COUNT"

​
propertyFilters
object
required

propertyFilters

​
parameters
object[]
required

Required parameters

Example:
[
  {
    "id": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
    "usageMetricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
    "name": "myParam",
    "type": "INTEGER",
    "description": "My parameter",
    "defaultValue": "10"
  }
]
​
description
string

Description for this metric

Example:

"Total length of sent messages."

​
aggregationProperty
string

Property within the event to aggregate

Example:

"message_length"

​
groupingProperty
string

Property within the event to group results by

Example:

"channel"

​
unit
string

Human-readable unit of the aggregated metric, eg. API calls)

Example:

"bytes"

​
createdAt
string

Created at

Example:

"2022-06-28T16:47:00Z"

​
deletedAt
string

Created at

Example:

"2022-06-28T16:47:00Z"

​
caseSensitive
boolean

caseSensitive

Example:

true

​
propertiesToNegate
string[]

propertiesToNegate

Example:
["channels"]