Get Meter

Retrieve details of a specific meter by ID.

GET /v1/meters/{id}

Get Meter

cURL

curl --request GET \
  --url https://api.example.com/v1/meters/{id}

200

{
  "id": "<string>",
  "name": "<string>",
  "tenant_id": "<string>",
  "event_name": "<string>",
  "aggregation": {
    "type": "<string>",
    "field": "<string>",
    "expression": "<string>",
    "multiplier": "<string>",
    "bucket_size": "<string>",
    "group_by": "<string>"
  },
  "filters": [
    {}
  ],
  "reset_usage": "<string>",
  "status": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Path Parameters

id · string · required

Unique identifier of the meter.

Example: "meter_550e8400e29b41d4a716446655440000"

Response

id · string

Unique identifier for the meter.

name · string

Human-readable name for the meter.

tenant_id · string

Tenant ID that owns this meter.

event_name · string

Name of the event being tracked.

aggregation · object

Aggregation configuration.

Show aggregation properties

type · string

Aggregation method.

field · string

Property name to aggregate.

expression · string

Optional CEL expression for custom aggregation.

multiplier · string

Decimal multiplier applied to the result.

bucket_size · string

Window size for bucketed aggregations.

group_by · string

Property to group by before aggregating.

filters · array

Array of filters applied to events before aggregation.

reset_usage · string

Determines when usage resets.

status · string

Status of the meter.

created_at · string

ISO 8601 timestamp when the meter was created.

updated_at · string

ISO 8601 timestamp when the meter was last updated.

Example Request

cURL

curl --request GET \
  --url https://api.flexprice.io/v1/meters/meter_550e8400e29b41d4a716446655440000 \
  --header 'Authorization: Bearer <token>'

Example Response

{
  "id": "meter_550e8400e29b41d4a716446655440000",
  "name": "API Usage Meter",
  "tenant_id": "tenant_123",
  "event_name": "api_request",
  "aggregation": {
    "type": "COUNT"
  },
  "filters": [
    {
      "key": "method",
      "values": ["GET", "POST"]
    }
  ],
  "reset_usage": "BILLING_PERIOD",
  "status": "published",
  "created_at": "2024-03-20T15:04:05Z",
  "updated_at": "2024-03-20T15:04:05Z"
}