Skip to navigation

Get delivered value

Returns the value delivered to a customer over a period, computed live from your active value model on every call — per value metric: its definition, a display-ready calculation, the measured unit total, monetary total, and signal counts, plus a per-event signal breakdown. The same data a value receipt presents, without creating one — built for value dashboards and reporting. Figures always reflect the currently active value model. Shortly after you publish a model change, totals can still be priced under the previous model’s rates.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Query parameters

customerIdstringOptional>=1 character

The customer to compute delivered value for. Accepts a Paid customer ID or, as a fallback, your external customer ID. Mutually exclusive with externalCustomerId; exactly one is required.

externalCustomerIdstringOptional>=1 character

Your external customer ID. Mutually exclusive with customerId; exactly one is required.

startDatestringRequired

Period start, inclusive. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

endDatestringRequired

Period end, inclusive — a date-only value means through the end of that UTC day. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

Response

200
currencystring

Currency for every monetary field in this response — the customer's override when one exists, else the value model's currency.

periodobject

The resolved period, echoing date-only inputs expanded to full UTC date-times.

customerobject
valueMetricslist of objects
One entry per value metric, ordered by the value model's display order. Archived metrics appear only when they delivered value in the period.
signalslist of objects

Per-event activity behind the metric totals, one entry per event. An event that feeds several value metrics appears once, and states its occurrences and its values once.

totalsobject

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
408
Request Timeout Error
429
Too Many Requests Error
500
Internal Server Error