GET
/
usage-metrics
/
{id}

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

id
string
required

Unique ID

Response

200 - application/json
id
string
required

Unique ID

sequenceAccountId
string
required

Sequence Account ID

name
string
required

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

metricType
enum<string>
required

Type of metric (simple or grouped)

Available options:
SIMPLE,
GROUPED
eventType
string
required

The eventType of the Usage Event to be aggregated

aggregationType
enum<string>
required

Type of aggregation to perform

Available options:
COUNT,
UNIQUE,
SUM,
CUSTOM
propertyFilters
object
required

propertyFilters

parameters
object[]
required

Required parameters

description
string

Description for this metric

aggregationProperty
string

Property within the event to aggregate

groupingProperty
string

Property within the event to group results by

unit
string

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

createdAt
string

Created at

deletedAt
string

Created at

caseSensitive
boolean

caseSensitive

propertiesToNegate
string[]

propertiesToNegate

Create a new Usage MetricUpdate a Usage Metric