RevKeen Docs
Api reference

List a customer's meter usage

Returns per-meter aggregates for a single customer. Requires a customer_id query parameter. For each meter the merchant has defined, the response includes the aggregate quantity (applying the meter's native aggregation function), the event count, and the most recent event timestamp.

Use this to render a customer's current consumption snapshot in your own UI — for example, a usage dashboard showing "4,820 / 10,000 requests this period".

Related endpoints

  • GET /customer-meters/{customer_id}/{meter_id} — Retrieve a customer-meter aggregate

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 unauthenticated — missing, malformed, or revoked API key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/customer-meters

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Query Parameters

customer_id*string

Customer UUID. Required — customer-meters are not queryable merchant-wide via this endpoint. Use /v2/meters for merchant-level meter definitions.

Formatuuid
meter_id?string

Optional single-meter filter. When provided, the response contains at most one entry.

Formatuuid

Response Body

application/json

application/json

application/json

curl "https://api.revkeen.com/v2/customer-meters?customer_id=value" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "object": "list",
  "data": [
    {
      "object": "customer_meter",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "meter_id": "1e13adc1-9ac9-453b-b100-17d2f2da2eb8",
      "meter_name": "string",
      "meter_event_name": "api_request",
      "aggregation": "sum",
      "unit_name": "requests",
      "total_quantity": 4820,
      "event_count": 412,
      "last_event_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": false,
  "url": "string"
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
Edit on GitHub