List

API Reference

V1

Billable Metrics

List all billable metrics

v1.billable_metrics.list(BillableMetricListParams**kwargs) -> SyncCursorPage[idstrnamestraggregation_keystraggregation_typeliteralarchived_atdatetimecustom_fieldsDict[str, str]event_type_filterEventTypeFiltergroup_keyslistproperty_filterslistsqlstrBillableMetricListResponse]

get/v1/billable-metrics

List all billable metrics.

Parameters

include_archivedbool

optional

If true, the list of returned metrics will include archived metrics

limitint

optional

Max number of results that should be returned

minimum1

maximum100

next_pagestr

optional

Cursor that indicates where the next page of results should start.

Returns

BillableMetricListResponseclass

Hide ParametersShow Parameters

idstr

ID of the billable metric

formatuuid

namestr

The display name of the billable metric.

aggregation_keystr

optional

A key that specifies which property of the event is used to aggregate data. This key must be one of the property filter names and is not applicable when the aggregation type is 'count'.

aggregation_typeliteral

optional

Optional[Literal["COUNT", "LATEST", "MAX", 2 more]]

Specifies the type of aggregation performed on matching events.

Hide ParametersShow Parameters

"COUNT"

"LATEST"

"MAX"

"SUM"

"UNIQUE"

archived_atdatetime

optional

RFC 3339 timestamp indicating when the billable metric was archived. If not provided, the billable metric is not archived.

formatdate-time

custom_fieldsDict[str, str]

optional

Optional[Dict[str, str]]

event_type_filterEventTypeFilter

optional

An optional filtering rule to match the 'event_type' property of an event.

group_keyslist

optional

Optional[List[List[str]]]

Property names that are used to group usage costs on an invoice. Each entry represents a set of properties used to slice events into distinct buckets.

property_filterslist

optional

Optional[List[namestrexistsboolin_valueslistnot_in_valueslistPropertyFilter]]

A list of filters to match events to this billable metric. Each filter defines a rule on an event property. All rules must pass for the event to match the billable metric.

Hide ParametersShow Parameters

namestr

The name of the event property.

existsbool

optional

Determines whether the property must exist in the event. If true, only events with this property will pass the filter. If false, only events without this property will pass the filter. If null or omitted, the existence of the property is optional.

in_valueslist

optional

Optional[List[str]]

Specifies the allowed values for the property to match an event. An event will pass the filter only if its property value is included in this list. If undefined, all property values will pass the filter. Must be non-empty if present.

not_in_valueslist

optional

Optional[List[str]]

Specifies the values that prevent an event from matching the filter. An event will not pass the filter if its property value is included in this list. If null or empty, all property values will pass the filter. Must be non-empty if present.

sqlstr

optional

The SQL query associated with the billable metric

HTTPTypeScriptPythonGoRubyTerraform

from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
page = client.v1.billable_metrics.list()
page = page.data[0]
print(page.id)

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name",
      "aggregation_key": "aggregation_key",
      "aggregation_type": "COUNT",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "custom_fields": {
        "foo": "string"
      },
      "event_type_filter": {
        "in_values": [
          "string"
        ],
        "not_in_values": [
          "string"
        ]
      },
      "group_keys": [
        [
          "string"
        ]
      ],
      "property_filters": [
        {
          "name": "name",
          "exists": true,
          "in_values": [
            "string"
          ],
          "not_in_values": [
            "string"
          ]
        }
      ],
      "sql": "sql"
    }
  ],
  "next_page": "next_page"
}