Get analytics totals
GET/v1/analytics/totalspreview
Get one row per key of a dimension with its counters summed over a range. Destination rows carry the name, including the last name of a deleted destination. A read that is too large is refused with 400 validation_failed, never cut short: one whose range holds more than 1000 keys, or covers too much detail. Narrow the range.
Query parameters
dimensionstring RequiredWhat the totals are keyed by: app (one row for the whole app), event_type, or destination.
Allowed values: "app", "event_type", "destination"
fromstring (date-time) RequiredThe inclusive start of the range, a whole UTC hour.
tostring (date-time) RequiredThe exclusive end of the range, a whole UTC hour.
Returns
The query result.200
dataobject RequiredOne row per key with its totals over the range.
dimensionstring RequiredWhat the totals are keyed by: app (one row for the whole app), event_type, or destination.
Allowed values: "app", "event_type", "destination"
fromstring (date-time) RequiredThe inclusive start of the range.
tostring (date-time) RequiredThe exclusive end of the range.
rowsobject[] RequiredOne row per key, sorted by key. The app dimension has one row with a null key.
Show child attributesHide child attributes
keystring | null RequiredThe destination ID or event type the row belongs to. Null for the app dimension. ‘’ for the app-wide latency row, and ‘pp/other’ for the event types past the monthly cap, which are counted together. Event types starting with ‘pp/’ are reserved.
namestring | null RequiredFor a destination row, the current name, or the last name before the destination was deleted. Null for another dimension, and for an ID the app never held.
deletedboolean RequiredTrue when the row is a destination that is deleted. False for another dimension.
valuesobject RequiredCounters summed over the range, by name, with the same names as a series point. Destination rows also carry the latency extremes in milliseconds.
Show child attributesHide child attributes
eventsnumber OptionalThe events counter.
quarter_unitsnumber OptionalThe quarter_units counter.
payload_bytesnumber OptionalThe payload_bytes counter.
deliveriesnumber OptionalThe deliveries counter.
deliveries_heldnumber OptionalThe deliveries_held counter.
transformsnumber OptionalThe transforms counter.
attemptsnumber OptionalThe attempts counter.
deliverednumber OptionalThe delivered counter.
failednumber OptionalThe failed counter.
retriednumber OptionalThe retried counter.
internal_errorsnumber OptionalThe internal_errors counter.
latency_sum_msnumber OptionalThe latency_sum_ms counter.
status_2xxnumber OptionalThe status_2xx counter.
status_3xxnumber OptionalThe status_3xx counter.
status_4xxnumber OptionalThe status_4xx counter.
status_5xxnumber OptionalThe status_5xx counter.
status_networknumber OptionalThe status_network counter.
unhealthynumber OptionalThe unhealthy counter.
ignorednumber OptionalThe ignored counter.
latency_min_msnumber OptionalThe latency_min_ms counter.
latency_max_msnumber OptionalThe latency_max_ms counter.
p50number OptionalThe p50 counter.
p95number OptionalThe p95 counter.
p99number OptionalThe p99 counter.
samplesnumber OptionalThe samples counter.
Example
curl -X GET "https://api.payloadpuffin.com/v1/analytics/totals?dimension=app&from=2026-10-21T00%3A00%3A00.000Z&to=2026-10-22T00%3A00%3A00.000Z" \
-H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"{
"data": {
"dimension": "app",
"from": "from",
"to": "to",
"rows": [
{
"key": "key",
"name": "name",
"deleted": true,
"values": {
"events": 0,
"quarter_units": 0,
"payload_bytes": 0,
"deliveries": 0,
"deliveries_held": 0,
"transforms": 0,
"attempts": 0,
"delivered": 0,
"failed": 0,
"retried": 0,
"internal_errors": 0,
"latency_sum_ms": 0,
"status_2xx": 0,
"status_3xx": 0,
"status_4xx": 0,
"status_5xx": 0,
"status_network": 0,
"unhealthy": 0,
"ignored": 0,
"latency_min_ms": 0,
"latency_max_ms": 0,
"p50": 0,
"p95": 0,
"p99": 0,
"samples": 0
}
}
]
}
}Errors
Errors use application/problem+json. The code member is stable; branch on it rather than on title or detail.
4XXapplication/problem+jsonThe request was rejected.