List Meters

List all usage meters belonging to your active business. You can filter by archived status.

GET /v1/meters

TypeScript SDK

TypeScript

import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// List usage meters
const meters = await solifyn.meters.list();
console.log('Usage Meters:', meters);

200

[
  {
    "id": "mtr_8Z1aB2cD3eF4gH5iJ6kL7m",
    "businessId": "biz_4r5t6y7u8i9o",
    "name": "API Request Count",
    "eventName": "api.request",
    "aggregationType": "COUNT",
    "archived": false,
    "createdAt": "2026-05-23T10:00:00.000Z",
    "updatedAt": "2026-05-23T10:00:00.000Z",
    "description": "Counts successful API requests for usage-based billing.",
    "aggregationKey": "tokens",
    "unit": "requests",
    "filters": {
      "event_type": "premium",
      "region": "asia"
    }
  }
]

Authorizations

Authorization · string · header · required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Query Parameters

status · enum<string>

Filter by meter status.

Available options: active, archived

Response

200 - application/json

Meters retrieved successfully.

id · string · required

The unique meter ID.

Example:

"mtr_8Z1aB2cD3eF4gH5iJ6kL7m"

businessId · string · required

The business ID that owns this meter.

Example:

"biz_4r5t6y7u8i9o"

name · string · required

Meter display name.

Example:

"API Request Count"

eventName · string · required

The event name tracked by this meter.

Example:

"api.request"

aggregationType · enum<string> · required

Aggregation strategy for usage events.

Available options: COUNT, SUM, MAX, LAST

Example:

"COUNT"

archived · boolean · required

Whether the meter is archived.

Example:

false

createdAt · string<date-time> · required

Creation timestamp.

Example:

"2026-05-23T10:00:00.000Z"

updatedAt · string<date-time> · required

Last update timestamp.

Example:

"2026-05-23T10:00:00.000Z"

description · object

Meter description.

Example:

"Counts successful API requests for usage-based billing."

aggregationKey · object

Metadata key used for aggregation.

Example:

"tokens"

unit · object

Measurement unit label.

Example:

"requests"

filters · object

Optional filter definition for advanced matching.

Example:

{ "event_type": "premium", "region": "asia" }