Skip to main content
POST
Create a billable metric

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01
Idempotency-Key
string

A unique string that makes a retried write safe. If you send the same request with the same key within 24 hours, the API returns the stored response and does not run the request again. A 5xx or 429 response is not stored, so a retry with that key runs the request again.

Maximum string length: 255
Example:

"ik_a1b2c3d4e5f6"

Body

application/json
aggregation
object
required

How events are aggregated into a metric value

event_name
string
required

Event name that triggers this metric

Example:

"api_call"

name
string
required

Name of the metric

Example:

"API Calls"

description
string | null

Description of the metric

Example:

"Counts API calls per customer"

filter_groups
object[]

Filter groups to apply to events before aggregation

tag_ids
string[]

Tag identifiers to associate with this metric

Response

Success

aggregation
object
required

How events are aggregated into a metric value

created_at
string<date-time>
required

Timestamp when the metric was created

Example:

"2026-04-01T10:00:00Z"

event_name
string
required

Event name that triggers this metric

Example:

"api_call"

id
string
required

Unique identifier for the metric

Example:

"mtr_01H1VECT"

name
string
required

Name of the metric

Example:

"API Calls"

updated_at
string<date-time>
required

Timestamp when the metric was last updated

Example:

"2026-04-01T12:30:00Z"

description
string | null

Description of the metric

Example:

"Counts API calls per customer"

filter_groups
object[]

Filter groups applied to events before aggregation

tag_ids
string[]

Tag identifiers associated with this metric