Skip to main content

update billable metric

PATCH 
/org/:orgId/billableMetric/:billableMetricId

Update the name, description and status of the billable metric for the given organization.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

    billableMetricId stringrequired

    Billable Metric ID

Body

required

RequestBody

    description string
    name string
    status BillableMetricStatus (string)

    Possible values: [ACTIVE, DELETED]

Responses​

OK

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]

Loading...