create billable metric

POST 
/org/:orgId/billableMetric

Create a new billable metric for the given organization.

Request

Path Parameters

orgId stringrequired

Organization ID

application/json

Body

required

RequestBody

aggregationType BillableMetricAggregationType (string)

Possible values: [COUNT, UNIQUE_COUNT, SUM, MAX, LAST]

creationTime date-time
description string

Possible values: <= 300 characters

id string

Possible values: <= 36 characters

info

object

filterGroups

object[]

FilterGroups is a list of filter groups. The filterGroups are connected by AND.

Array [

filters

object[]

Array [

name string

operation BillableMetricFilterOperation (string)

Possible values: [IS, NOT_IS, CONTAINS, NOT_CONTAINS, GT, GTE, LT, LTE, EQ, NOT_EQ, EXISTS, NOT_EXISTS]

value

The value of the filter. The type of the value depends on the valueType.

valueType BillableMetricFilterValueType (string)

Possible values: [STRING, FLOAT]

]

]

groupBys string[]

GroupBys is a list of fields to group by.

propertyUniqueOn string

The target property for unique count aggregate.

lastUpdateTime date-time
name string

Possible values: >= 4 characters and <= 50 characters

organizationId string
status BillableMetricStatus (string)

Possible values: [ACTIVE, DELETED]

Responses

200

OK

application/json

Schema

Schema

aggregationType BillableMetricAggregationType (string)

Possible values: [COUNT, UNIQUE_COUNT, SUM, MAX, LAST]

creationTime date-time
description string

Possible values: <= 300 characters

id string

Possible values: <= 36 characters

info

object

filterGroups

object[]

FilterGroups is a list of filter groups. The filterGroups are connected by AND.

Array [

filters

object[]

Array [

name string

operation BillableMetricFilterOperation (string)

Possible values: [IS, NOT_IS, CONTAINS, NOT_CONTAINS, GT, GTE, LT, LTE, EQ, NOT_EQ, EXISTS, NOT_EXISTS]

value

The value of the filter. The type of the value depends on the valueType.

valueType BillableMetricFilterValueType (string)

Possible values: [STRING, FLOAT]

]

]

groupBys string[]

GroupBys is a list of fields to group by.

propertyUniqueOn string

The target property for unique count aggregate.

lastUpdateTime date-time
name string

Possible values: >= 4 characters and <= 50 characters

organizationId string
status BillableMetricStatus (string)

Possible values: [ACTIVE, DELETED]

Example (from schema)

{
  "aggregationType": "COUNT",
  "creationTime": "2024-08-12T01:02:12.724Z",
  "description": "string",
  "id": "string",
  "info": {
    "filterGroups": [
      {
        "filters": [
          {
            "name": "string",
            "operation": "IS",
            "valueType": "STRING"
          }
        ]
      }
    ],
    "groupBys": [
      "string"
    ],
    "propertyUniqueOn": "string"
  },
  "lastUpdateTime": "2024-08-12T01:02:12.724Z",
  "name": "string",
  "organizationId": "string",
  "status": "ACTIVE"
}

400

Bad request params

application/json

Schema

Schema

string

500

Internal server error

application/json

Schema

Schema

string

Loading...