Retrieve

API Reference

Billable Metrics

Get a billable metric

client.v1.billableMetrics.retrieve(, ?):

get/v1/billable-metrics/{billable_metric_id}

Get a billable metric.

Parameters

params

Hide ParametersShow Parameters

billable_metric_idstring

formatuuid

Returns

BillableMetricRetrieveResponse

Hide ParametersShow Parameters

data

Hide ParametersShow Parameters

idstring

ID of the billable metric

formatuuid

namestring

The display name of the billable metric.

aggregation_keystring

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_typeunion

optional

"COUNT" | "LATEST" | "MAX" | 2 more

Specifies the type of aggregation performed on matching events.

Hide ParametersShow Parameters

"COUNT"

"LATEST"

"MAX"

"SUM"

"UNIQUE"

archived_atstring

optional

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

formatdate-time

custom_fieldsRecord<string, string>

optional

event_type_filter

optional

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

group_keysarray

optional

Array<Array<string>>

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_filtersarray

optional

Array<>

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

namestring

The name of the event property.

existsboolean

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_valuesarray

optional

Array<string>

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_valuesarray

optional

Array<string>

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.

sqlstring

optional

The SQL query associated with the billable metric

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const billableMetric = await client.v1.billableMetrics.retrieve({
  billable_metric_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
});

console.log(billableMetric.data);

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"
  }
}