Sign in
app

A simple ViewSet for viewing and editing Billable Metrics.

post/app/metrics/

Request body

event_namestring

Name of the event that this metric is tracking.

property_namestring nullable

The name of the property of the event that should be used for this metric. Doesn't apply if the metric is of type 'counter' with an aggregation of count.

usage_aggregation_type'count' | 'sum' | 'max' | 'unique' | 'latest' | 'average' | 'null' nullable

The type of aggregation that should be used for this metric. Please refer to our documentation for an explanation of the different types.

billable_aggregation_type'count' | 'sum' | 'max' | 'unique' | 'latest' | 'average' | 'null' nullable
granularity'seconds' | 'minutes' | 'hours' | 'days' | 'months' | 'quarters' | 'years' | 'total' | 'null' nullable

The granularity of the metric. Only applies to metrics of type 'gauge' or 'rate'.

event_type'delta' | 'total' | 'null' nullable

Used only for metrics of type 'gauge'. Please refer to our documentation for an explanation of the different types.

metric_type'counter' | 'rate' | 'custom' | 'gauge' required

The type of metric that this is. Please refer to our documentation for an explanation of the different types.

metric_namestring required
proration'seconds' | 'minutes' | 'hours' | 'days' | 'months' | 'quarters' | 'years' | 'total' | 'null' nullable

The proration of the metric. Only applies to metrics of type 'gauge'.

propertiesobject nullable
is_cost_metricboolean

Whether or not this metric is a cost metric (used to track costs to your business).

custom_sqlstring nullable

A custom SQL query that can be used to define the metric. Please refer to our documentation for more information.

Response

metric_idstring required
event_namestring required

Name of the event that this metric is tracking.

property_namestring nullable required

The name of the property of the event that should be used for this metric. Doesn't apply if the metric is of type 'counter' with an aggregation of count.

aggregation_typestring required
granularity'seconds' | 'minutes' | 'hours' | 'days' | 'months' | 'quarters' | 'years' | 'total' | 'null' nullable required

The granularity of the metric. Only applies to metrics of type 'gauge' or 'rate'.

event_type'delta' | 'total' | 'null' nullable required

Used only for metrics of type 'gauge'. Please refer to our documentation for an explanation of the different types.

metric_type'counter' | 'rate' | 'custom' | 'gauge' required

The type of metric that this is. Please refer to our documentation for an explanation of the different types.

metric_namestring required
is_cost_metricboolean required

Whether or not this metric is a cost metric (used to track costs to your business).

custom_sqlstring nullable required

A custom SQL query that can be used to define the metric. Please refer to our documentation for more information.

proration'seconds' | 'minutes' | 'hours' | 'days' | 'months' | 'quarters' | 'years' | 'total' | 'null' nullable required

The proration of the metric. Only applies to metrics of type 'gauge'.

Changes