Sign in
Meters

List meters

List meters.

get/v3/openmeter/meters

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sort meters returned in the response. Supported sort attributes are:

  • key
  • name
  • aggregation
  • created_at (default)
  • updated_at

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.

Filter meters returned in the response.

To filter meters by key add the following query param: filter[key]=my-meter-key

Response

Page paginated response.

Example response

{
  "data": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "key": "tokens_total",
      "name": "Tokens Total",
      "description": "AI Token Usage",
      "aggregation": "sum",
      "event_type": "prompt",
      "value_property": "$.tokens",
      "dimensions": {
        "model": "$.model",
        "type": "$.type"
      },
      "created_at": "2024-01-01T01:01:01.001Z",
      "updated_at": "2024-01-01T01:01:01.001Z"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

Changed in 2 of the 75 revisions of this API.5

  • 86981188d9114See the full diff
    • ○

      added the new optional query request parameter filter

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort

      new-optional-request-parameter

    • ○

      the response property data/items/created_at became required for the status 200

      response-property-became-required

    • ○

      the response property data/items/updated_at became required for the status 200

      response-property-became-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d5eb242b4c931See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog