POST
/
usage-metrics

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
aggregationType
enum<string>
required

Type of aggregation to perform

Available options:
COUNT,
UNIQUE,
SUM,
CUSTOM
eventType
string
required

The eventType of the Usage Event to be aggregated

metricType
enum<string>
required

Type of metric (simple or grouped)

Available options:
SIMPLE,
GROUPED
name
string
required

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

aggregationProperty
string

Property within the event to aggregate

caseSensitive
boolean

caseSensitive

deletedAt
string

Created at

description
string

Description for this metric

groupingProperty
string

Property within the event to group results by

propertiesToNegate
string[]

propertiesToNegate

propertyFilters
object

propertyFilters

unit
string

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

Response

201 - application/json
aggregationType
enum<string>
required

Type of aggregation to perform

Available options:
COUNT,
UNIQUE,
SUM,
CUSTOM
eventType
string
required

The eventType of the Usage Event to be aggregated

id
string
required

Unique ID

metricType
enum<string>
required

Type of metric (simple or grouped)

Available options:
SIMPLE,
GROUPED
name
string
required

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

parameters
object[]
required

Required parameters

propertyFilters
object
required

propertyFilters

sequenceAccountId
string
required

Sequence Account ID

aggregationProperty
string

Property within the event to aggregate

caseSensitive
boolean

caseSensitive

createdAt
string

Created at

deletedAt
string

Created at

description
string

Description for this metric

groupingProperty
string

Property within the event to group results by

propertiesToNegate
string[]

propertiesToNegate

unit
string

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