Meters

Endpointhttps://api.kontorion.eu/v1

List threshold-breach events across every meter in the org

GET

https://api.kontorion.eu/v1

/breaches

List threshold-breach events across every meter in the org › query Parameters

limit

integer

Number of items

List threshold-breach events across every meter in the org › Responses

200

object[]

action_event_type

string

action_kind

string

action_target

string

comparator

string

delivered_at

string

id

string

meter_id

string

meter_key

string

observed_value

string

occurred_at

string

organization_id

string

product_id

string

subscription_id

string

threshold_name

string

threshold_value

string

window_end

string

window_start

string

List meters

GET

https://api.kontorion.eu/v1

/meters

Returns a paginated list of meters. Supports the unified field.op=value filter grammar.

List meters › query Parameters

limit

integer

Number of items per page

cursor

string

Pagination cursor

List meters › Responses

200

Paginated list wrapped in data envelope

object[]

object

created_at

string

dedup_key_path

string

dimensions

string[]

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

id

string

key

string

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

metric_key

string

name

string

negative_allowed

boolean

organization_id

string

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

updated_at

string

value_field

string

object

workspace_id

string

GET/meters

curl --request GET \
  --url https://api.kontorion.eu/v1/meters

shell

Example Responses

{
  "key": [
    {
      "composed_of": {
        "expression": "expression",
        "variables": {
          "key": "string"
        }
      },
      "created_at": "created_at",
      "dedup_key_path": "dedup_key_path",
      "dimensions": [
        "string"
      ],
      "event_schema": {},
      "filter_tree": {
        "root": {
          "children": [
            null
          ],
          "field": "field",
          "op": "AND",
          "value": {}
        }
      },
      "function": "SUM",
      "id": "id",
      "key": "key",
      "late_event_policy": "DROP",
      "metric_key": "metric_key",
      "name": "name",
      "negative_allowed": true,
      "organization_id": "organization_id",
      "thresholds": [
        {
          "action": {
            "event_type": "event_type",
            "kind": "webhook",
            "target": "target"
          },
          "comparator": "gt",
          "name": "name",
          "value": 0
        }
      ],
      "unique_by_field": "unique_by_field",
      "unit_currency_field": "unit_currency_field",
      "unit_label": "unit_label",
      "updated_at": "updated_at",
      "value_field": "value_field",
      "window": {
        "duration": 0,
        "kind": "CALENDAR_HOURLY",
        "session_gap": 0
      },
      "workspace_id": "workspace_id"
    }
  ]
}

json

application/json

Create a meter

POST

https://api.kontorion.eu/v1

/meters

Creates an org-scoped meter usable by any product.

Create a meter › Request Body

object

dedup_key_path

string

dimensions

string[]

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

key

string

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

metric_key

string

name

string

negative_allowed

boolean

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

value_field

string

object

nil → DefaultWindow()

Create a meter › Responses

Wrapped in data envelope

object

created_at

string

dedup_key_path

string

dimensions

string[]

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

id

string

key

string

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

metric_key

string

name

string

negative_allowed

boolean

organization_id

string

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

updated_at

string

value_field

string

object

workspace_id

string

POST/meters

curl --request POST \
  --url https://api.kontorion.eu/v1/meters \
  --header 'Content-Type: application/json' \
  --data '
{
  "composed_of": {
    "expression": "expression",
    "variables": {
      "key": "string"
    }
  },
  "dedup_key_path": "dedup_key_path",
  "dimensions": [
    "string"
  ],
  "event_schema": {},
  "filter_tree": {
    "root": {
      "children": [
        null
      ],
      "field": "field",
      "op": "AND",
      "value": {}
    }
  },
  "function": "SUM",
  "key": "key",
  "late_event_policy": "DROP",
  "metric_key": "metric_key",
  "name": "name",
  "negative_allowed": true,
  "thresholds": [
    {
      "action": {
        "event_type": "event_type",
        "kind": "webhook",
        "target": "target"
      },
      "comparator": "gt",
      "name": "name",
      "value": 0
    }
  ],
  "unique_by_field": "unique_by_field",
  "unit_currency_field": "unit_currency_field",
  "unit_label": "unit_label",
  "value_field": "value_field",
  "window": {
    "duration": 0,
    "kind": "CALENDAR_HOURLY",
    "session_gap": 0
  }
}
'

shell

Example Request Body

{
  "composed_of": {
    "expression": "expression",
    "variables": {
      "key": "string"
    }
  },
  "dedup_key_path": "dedup_key_path",
  "dimensions": [
    "string"
  ],
  "event_schema": {},
  "filter_tree": {
    "root": {
      "children": [
        null
      ],
      "field": "field",
      "op": "AND",
      "value": {}
    }
  },
  "function": "SUM",
  "key": "key",
  "late_event_policy": "DROP",
  "metric_key": "metric_key",
  "name": "name",
  "negative_allowed": true,
  "thresholds": [
    {
      "action": {
        "event_type": "event_type",
        "kind": "webhook",
        "target": "target"
      },
      "comparator": "gt",
      "name": "name",
      "value": 0
    }
  ],
  "unique_by_field": "unique_by_field",
  "unit_currency_field": "unit_currency_field",
  "unit_label": "unit_label",
  "value_field": "value_field",
  "window": {
    "duration": 0,
    "kind": "CALENDAR_HOURLY",
    "session_gap": 0
  }
}

json

Example Responses

{
  "key": {
    "composed_of": {
      "expression": "expression",
      "variables": {
        "key": "string"
      }
    },
    "created_at": "created_at",
    "dedup_key_path": "dedup_key_path",
    "dimensions": [
      "string"
    ],
    "event_schema": {},
    "filter_tree": {
      "root": {
        "children": [
          null
        ],
        "field": "field",
        "op": "AND",
        "value": {}
      }
    },
    "function": "SUM",
    "id": "id",
    "key": "key",
    "late_event_policy": "DROP",
    "metric_key": "metric_key",
    "name": "name",
    "negative_allowed": true,
    "organization_id": "organization_id",
    "thresholds": [
      {
        "action": {
          "event_type": "event_type",
          "kind": "webhook",
          "target": "target"
        },
        "comparator": "gt",
        "name": "name",
        "value": 0
      }
    ],
    "unique_by_field": "unique_by_field",
    "unit_currency_field": "unit_currency_field",
    "unit_label": "unit_label",
    "updated_at": "updated_at",
    "value_field": "value_field",
    "window": {
      "duration": 0,
      "kind": "CALENDAR_HOURLY",
      "session_gap": 0
    },
    "workspace_id": "workspace_id"
  }
}

json

application/json

Get a meter

GET

https://api.kontorion.eu/v1

/meters/{id}

Get a meter › path Parameters

id

string · required

Meter UUID

Get a meter › Responses

Wrapped in data envelope

object

created_at

string

dedup_key_path

string

dimensions

string[]

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

id

string

key

string

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

metric_key

string

name

string

negative_allowed

boolean

organization_id

string

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

updated_at

string

value_field

string

object

workspace_id

string

GET/meters/{id}

curl --request GET \
  --url https://api.kontorion.eu/v1/meters/:id

shell

Example Responses

{
  "key": {
    "composed_of": {
      "expression": "expression",
      "variables": {
        "key": "string"
      }
    },
    "created_at": "created_at",
    "dedup_key_path": "dedup_key_path",
    "dimensions": [
      "string"
    ],
    "event_schema": {},
    "filter_tree": {
      "root": {
        "children": [
          null
        ],
        "field": "field",
        "op": "AND",
        "value": {}
      }
    },
    "function": "SUM",
    "id": "id",
    "key": "key",
    "late_event_policy": "DROP",
    "metric_key": "metric_key",
    "name": "name",
    "negative_allowed": true,
    "organization_id": "organization_id",
    "thresholds": [
      {
        "action": {
          "event_type": "event_type",
          "kind": "webhook",
          "target": "target"
        },
        "comparator": "gt",
        "name": "name",
        "value": 0
      }
    ],
    "unique_by_field": "unique_by_field",
    "unit_currency_field": "unit_currency_field",
    "unit_label": "unit_label",
    "updated_at": "updated_at",
    "value_field": "value_field",
    "window": {
      "duration": 0,
      "kind": "CALENDAR_HOURLY",
      "session_gap": 0
    },
    "workspace_id": "workspace_id"
  }
}

json

application/json

Update a meter

PUT

https://api.kontorion.eu/v1

/meters/{id}

Update a meter › path Parameters

id

string · required

Meter UUID

Update a meter › Request Body

object

dedup_key_path

string

dimensions

string[]

effective_at

string

ADR-0006 edit-as-publish controls.

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

name

string

negative_allowed

boolean

save_as_draft

boolean

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

value_field

string

object

Update a meter › Responses

Wrapped in data envelope

object

created_at

string

dedup_key_path

string

dimensions

string[]

event_schema

object

function

string · enum

Enum values:

SUM

COUNT

MAX

MIN

AVG

UNIQUE_COUNT

LAST

P95

id

string

key

string

late_event_policy

string · enum

Enum values:

DROP

CLAMP_TO_PERIOD

REBILL_PRIOR

metric_key

string

name

string

negative_allowed

boolean

organization_id

string

object[]

unique_by_field

string

unit_currency_field

string

unit_label

string

updated_at

string

value_field

string

object

workspace_id

string

PUT/meters/{id}

curl --request PUT \
  --url https://api.kontorion.eu/v1/meters/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "composed_of": {
    "expression": "expression",
    "variables": {
      "key": "string"
    }
  },
  "dedup_key_path": "dedup_key_path",
  "dimensions": [
    "string"
  ],
  "effective_at": "effective_at",
  "event_schema": {},
  "filter_tree": {
    "root": {
      "children": [
        null
      ],
      "field": "field",
      "op": "AND",
      "value": {}
    }
  },
  "function": "SUM",
  "late_event_policy": "DROP",
  "name": "name",
  "negative_allowed": true,
  "save_as_draft": true,
  "thresholds": [
    {
      "action": {
        "event_type": "event_type",
        "kind": "webhook",
        "target": "target"
      },
      "comparator": "gt",
      "name": "name",
      "value": 0
    }
  ],
  "unique_by_field": "unique_by_field",
  "unit_currency_field": "unit_currency_field",
  "unit_label": "unit_label",
  "value_field": "value_field",
  "window": {
    "duration": 0,
    "kind": "CALENDAR_HOURLY",
    "session_gap": 0
  }
}
'

shell

Example Request Body

{
  "composed_of": {
    "expression": "expression",
    "variables": {
      "key": "string"
    }
  },
  "dedup_key_path": "dedup_key_path",
  "dimensions": [
    "string"
  ],
  "effective_at": "effective_at",
  "event_schema": {},
  "filter_tree": {
    "root": {
      "children": [
        null
      ],
      "field": "field",
      "op": "AND",
      "value": {}
    }
  },
  "function": "SUM",
  "late_event_policy": "DROP",
  "name": "name",
  "negative_allowed": true,
  "save_as_draft": true,
  "thresholds": [
    {
      "action": {
        "event_type": "event_type",
        "kind": "webhook",
        "target": "target"
      },
      "comparator": "gt",
      "name": "name",
      "value": 0
    }
  ],
  "unique_by_field": "unique_by_field",
  "unit_currency_field": "unit_currency_field",
  "unit_label": "unit_label",
  "value_field": "value_field",
  "window": {
    "duration": 0,
    "kind": "CALENDAR_HOURLY",
    "session_gap": 0
  }
}

json

Example Responses

{
  "key": {
    "composed_of": {
      "expression": "expression",
      "variables": {
        "key": "string"
      }
    },
    "created_at": "created_at",
    "dedup_key_path": "dedup_key_path",
    "dimensions": [
      "string"
    ],
    "event_schema": {},
    "filter_tree": {
      "root": {
        "children": [
          null
        ],
        "field": "field",
        "op": "AND",
        "value": {}
      }
    },
    "function": "SUM",
    "id": "id",
    "key": "key",
    "late_event_policy": "DROP",
    "metric_key": "metric_key",
    "name": "name",
    "negative_allowed": true,
    "organization_id": "organization_id",
    "thresholds": [
      {
        "action": {
          "event_type": "event_type",
          "kind": "webhook",
          "target": "target"
        },
        "comparator": "gt",
        "name": "name",
        "value": 0
      }
    ],
    "unique_by_field": "unique_by_field",
    "unit_currency_field": "unit_currency_field",
    "unit_label": "unit_label",
    "updated_at": "updated_at",
    "value_field": "value_field",
    "window": {
      "duration": 0,
      "kind": "CALENDAR_HOURLY",
      "session_gap": 0
    },
    "workspace_id": "workspace_id"
  }
}

json

application/json

Delete a meter

DELETE

https://api.kontorion.eu/v1

/meters/{id}

Fails with 409 if any product binding still references this meter.

Delete a meter › path Parameters

id

string · required

Meter UUID

Delete a meter › Responses

No content

No data returned

List bindings for a meter

GET

https://api.kontorion.eu/v1

/meters/{id}/bindings

Returns every product-meter binding that references the meter, across products.

List bindings for a meter › path Parameters

id

string · required

Meter UUID

List bindings for a meter › Responses

Wrapped in data envelope

object[]

created_at

string

head_version_id

string

id

string

included_quantity_source

string · enum

Enum values:

PLAN_PIN

METER_WINDOW

NONE

object

meter_id

string

organization_id

string

overlay_dimensions_keyed

string[]

object

pricing_var_name

string

product_id

string

role

string · enum

Enum values:

BILLABLE_QUANTITY

PRICING_VAR

INFORMATIONAL

rollover_eligible

boolean

updated_at

string

workspace_id

string

GET/meters/{id}/bindings

curl --request GET \
  --url https://api.kontorion.eu/v1/meters/:id/bindings

shell

Example Responses

{
  "key": [
    {
      "created_at": "created_at",
      "head_version_id": "head_version_id",
      "id": "id",
      "included_quantity_source": "PLAN_PIN",
      "meter": {
        "function": "SUM",
        "id": "id",
        "key": "key",
        "name": "name",
        "unit_label": "unit_label"
      },
      "meter_id": "meter_id",
      "organization_id": "organization_id",
      "overlay_dimensions_keyed": [
        "string"
      ],
      "overlay_filters": {
        "root": {
          "children": [
            null
          ],
          "field": "field",
          "op": "AND",
          "value": {}
        }
      },
      "pricing_var_name": "pricing_var_name",
      "product_id": "product_id",
      "role": "BILLABLE_QUANTITY",
      "rollover_eligible": true,
      "updated_at": "updated_at",
      "workspace_id": "workspace_id"
    }
  ]
}

json

application/json

List threshold-breach events for a meter

GET

https://api.kontorion.eu/v1

/meters/{id}/breaches

Reads from the shared domain_event_outbox; newest first; capped at the standard pagination limit.

List threshold-breach events for a meter › path Parameters

id

string · required

Meter UUID

List threshold-breach events for a meter › query Parameters

limit

integer

Number of items

List threshold-breach events for a meter › Responses

object[]

action_event_type

string

action_kind

string

action_target

string

comparator

string

delivered_at

string

id

string

meter_id

string

meter_key

string

observed_value

string

occurred_at

string

organization_id

string

product_id

string

subscription_id

string

threshold_name

string

threshold_value

string

window_end

string

window_start

string

GET/meters/{id}/breaches

curl --request GET \
  --url https://api.kontorion.eu/v1/meters/:id/breaches

shell

Example Responses

[
  {
    "action_event_type": "action_event_type",
    "action_kind": "action_kind",
    "action_target": "action_target",
    "comparator": "comparator",
    "delivered_at": "delivered_at",
    "id": "id",
    "meter_id": "meter_id",
    "meter_key": "meter_key",
    "observed_value": "observed_value",
    "occurred_at": "occurred_at",
    "organization_id": "organization_id",
    "product_id": "product_id",
    "subscription_id": "subscription_id",
    "threshold_name": "threshold_name",
    "threshold_value": "threshold_value",
    "window_end": "window_end",
    "window_start": "window_start"
  }
]

json

application/json

Daily breach counts for a meter

GET

https://api.kontorion.eu/v1

/meters/{id}/breaches/aggregate

Daily count of threshold-breach events for one meter over a recent window. Powers the threshold-rail sparkline.

Daily breach counts for a meter › path Parameters

id

string · required

Meter UUID

Daily breach counts for a meter › query Parameters

days

integer

Window in days (1-90, default 30)

Daily breach counts for a meter › Responses

object[]

bucket

string

count

integer

List meter versions (with lifecycle filter)

GET

https://api.kontorion.eu/v1

/meters/{id}/versions

List meter versions (with lifecycle filter) › path Parameters

id

string · required

Meter UUID

List meter versions (with lifecycle filter) › query Parameters

status

string[] · style: form

Lifecycle status filter (repeatable)

List meter versions (with lifecycle filter) › Responses

200

object[]

archived_reason

string

created_at

string

created_by

string

effective_from

string

effective_to

string

id

string

ID is the *_versions.id UUID. Phase 2.D needs it so the FE stage-mode chip can wire selection→pin map without a separate number→ID lookup; older clients can ignore the field.

published_at

string

status

string

usage_count

integer

version

integer

object[]

Get a meter version snapshot

GET

https://api.kontorion.eu/v1

/meters/{id}/versions/{version}

Get a meter version snapshot › path Parameters

id

string · required

Meter UUID

version

integer · required

Version number

Get a meter version snapshot › Responses

200

created_at

string

effective_from

string

effective_to

string

filter_tree

function

string

id

string

meter_id

string

organization_id

string

value_field

string

version

integer

window

workspace_id

string

AuditRetention BulkArchive