Meters

List meters

Changed on

List meters.

get/openmeter/meters

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/meters
  • Auth: none declared

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

  • v33be06f269447Revision changes
    • info

      for the query request parameter filter, the format of property key/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property key/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property name/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was generalized from ArrayEncoding.commaDelimited to no format

    • info

      for the query request parameter filter, the format of property name/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was generalized from ArrayEncoding.commaDelimited to no format

  • v39d0042cb3815Revision changes
    • breaking

      for the query request parameter filter, the format of property key/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property key/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property name/allOf[StringFieldFilter]/anyOf[subschema #2]/ocontains was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

      for the query request parameter filter, the format of property name/allOf[StringFieldFilter]/anyOf[subschema #2]/oeq was specialized from no format to ArrayEncoding.commaDelimited