analytics
Stable. Describes behaviour that is built and covered by tests in this repository.
GET /v1/analytics/usage #
Usage series of one meter (estimates; invoices come from billing)
Near-real-time, from ClickHouse. The default series comes from an hourly rollup that may over-count by the duplicate
delivery rate (precision: estimated); exact=true recomputes it from deduplicated events and covers at most one day
(precision: exact).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
meter required | query | string | |
from required | query | string · date-time | |
to required | query | string · date-time | |
granularity | query | hour | day | |
customer | query | string | Customer external id |
exact | query | boolean |
Responses
| Status | Meaning | Body |
|---|---|---|
200 | OK | GetAnalyticsUsageResponse |
400 | Error envelope | Error |
404 | Error envelope | Error |
429 | Error envelope | Error |
Example response
{
"precision": "estimated",
"quantity_scale": 1,
"points": [
{
"start": "2026-11-03T10:15:00Z",
"quantity": "1.500",
"event_count": "string"
}
]
}curl
curl -X GET https://YOUR-API-ADDRESS/v1/analytics/usage \
-H "Authorization: Bearer $PAYRUDDER_API_KEY"GET /v1/analytics/top-customers #
Customers ranked by usage of a meter in a billing period (deduplicated)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
meter required | query | string | |
period required | query | string | |
limit | query | integer |
Responses
| Status | Meaning | Body |
|---|---|---|
200 | OK | GetTopCustomersResponse |
400 | Error envelope | Error |
429 | Error envelope | Error |
Example response
{
"precision": "string",
"quantity_scale": 1,
"customers": [
{
"customer_id": "string",
"customer_external_id": "string",
"quantity": "string",
"event_count": "string"
}
]
}curl
curl -X GET https://YOUR-API-ADDRESS/v1/analytics/top-customers \
-H "Authorization: Bearer $PAYRUDDER_API_KEY"Models
Error
| Field | Type | Description |
|---|---|---|
error required | object |
GetAnalyticsUsagePoint
| Field | Type | Description |
|---|---|---|
start required | string · date-time | |
quantity required | string | |
event_count required | string · int64 |
GetAnalyticsUsageResponse
| Field | Type | Description |
|---|---|---|
precision required | estimated | exact | |
quantity_scale required | integer | |
points required | array of GetAnalyticsUsagePoint |
GetTopCustomersCustomer
| Field | Type | Description |
|---|---|---|
customer_id required | string | |
customer_external_id required | string | |
quantity required | string | |
event_count required | string · int64 |
GetTopCustomersResponse
| Field | Type | Description |
|---|---|---|
precision required | string | |
quantity_scale required | integer | |
customers required | array of GetTopCustomersCustomer |