OpenMeter Features

List features

Changed on

List all features.

get/openmeter/features

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/features
  • 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 features returned in the response. Supported sort attributes are:

  • key
  • name
  • 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 features returned in the response.

To filter features by meter_id add the following query param: filter[meter_id][oeq]=<id>

{
  "meter_id": "01G65Z755AFWAKHE12NY0CQ9FH"
}

Response

Page paginated response.

Example response

{
  "data": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "labels": {
        "env": "test"
      },
      "created_at": "2023-01-01T01:01:01.001Z",
      "updated_at": "2023-01-01T01:01:01.001Z",
      "deleted_at": "2023-01-01T01:01:01.001Z",
      "key": "resource_key",
      "meter": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      }
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

  • v33be06f269447Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

      for the query request parameter filter, the format of property name/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/anyOf[subschema #2]/ocontains was specialized from no format to ArrayEncoding.commaDelimited

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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