Skip to main content

Create metric​

This endpoint is used to create a metric using a SQL string. See SQL support for a description of constructing SQL queries with examples.

Request Body required
    metadata object nullable

    User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

    property name* string nullable
    sql string required

    A sql string defining the metric.

    name string required

    The name of the metric.

    item_id string required

    The id of the item

    description string nullable required

    A description of the metric.

Responses

OK

Response Headers
    Schema
      metadata object required

      User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

      property name* string
      id string required
      name string required
      description string nullable required
      status string required

      Possible values: [active, draft, archived]

      item object required

      The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics, and prices and are used for defining external sync behavior for invoices and tax calculation purposes.

      id string required
      name string required
      created_at date-time required
      external_connections object[] required
    • Array [
      • external_connection_name object required
      oneOf

      string

      external_entity_id string required
    • ]
    Loading...