Meters

List your meters, newest first, as a cursor page. Archived meters are hidden unless include_archived=true.

get/v1/meters

Request

Query parameters

limitnumber

Maximum number of meters to return

starting_afterstring
Example:mtr_abc123

Cursor for forward pagination — meter ID to start after

ending_beforestring
Example:mtr_abc123

Cursor for backward pagination — meter ID to end before

include_archivedboolean

Include archived meters in the page. Defaults to false — archived meters are hidden.

Response

Paginated list of meters

objectstring required

Object type

has_moreboolean required

Whether more items exist beyond this page

Example response

{
  "object": "list",
  "data": [
    {
      "id": "mtr_abc123",
      "store_id": "sto_abc123",
      "name": "Image generations",
      "event_name": "image.generated",
      "aggregation": "sum",
      "aggregation_property": "tokens",
      "filter": {
        "conjunction": "and",
        "clauses": [
          {
            "property": "tier",
            "operator": "equals"
          }
        ]
      },
      "unit_label": "images",
      "status": "active"
    }
  ]
}

Changes