Skip to main content

List metrics​

This endpoint is used to fetch metric details given a metric identifier. It returns information about the metrics including its name, description, and item.

Query Parameters
    limit integer

    Possible values: >= 1 and <= 1000

    Default value: 20

    cursor string
    created_at[gte] date-time
    created_at[gt] date-time
    created_at[lt] date-time
    created_at[lte] date-time
Responses

OK

Response Headers
    Schema
      data object[] required
    • Array [
      • 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
    • ]
    • ]
      • pagination_metadata object required
      has_more boolean required
      next_cursor string nullable required
    Loading...