Meters API
The Meters API allows you to track and manage usage meters for billing purposes.
List Meters
Retrieve all meters:
bash
GET /v1/meters
Query Parameters
page: Page number (default: 1)per_page: Items per page (default: 20)status: Filter by status (active, inactive)
Get Meter
Retrieve a specific meter:
bash
GET /v1/meters/{meter_id}
Create Meter
Create a new usage meter:
bash
POST /v1/meters
Content-Type: application/json
{
"name": "API Calls",
"unit": "request",
"aggregation": "sum"
}
Meter Types
- Counter: Increments a value
- Gauge: Sets a value
- Histogram: Tracks distribution
Record Usage
Record usage for a meter:
bash
POST /v1/meters/{meter_id}/usage
Content-Type: application/json
{
"value": 100,
"timestamp": "2024-01-15T10:00:00Z"
}
Get Meter Usage
Retrieve usage data for a meter:
bash
GET /v1/meters/{meter_id}/usage?start_date=2024-01-01&end_date=2024-01-31
Is this page helpful?