Evaluate multiple prices
This endpoint is used to evaluate the output of price(s) for a given customer and time range over ingested events. It enables filtering and grouping the output using computed properties, supporting the following workflows:
- Showing detailed usage and costs to the end customer.
- Auditing subtotals on invoice line items.
For these workflows, the expressiveness of computed properties in both the filters and grouping is critical.
For example, if you’d like to show your customer their usage grouped by hour and another property, you can
do so with the following grouping_keys
:
["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]
.
If you’d like to examine a customer’s usage for a specific property value, you can do so with the following filter
:
my_property = 'foo' AND my_other_property = 'bar'
.
Prices may either reference existing prices in your Orb account or be defined inline in the request body. Up to 100 prices can be evaluated in a single request.
Prices are evaluated on ingested events and the start of the time range must be no more than 100 days ago. To evaluate based off a set of provided events, the evaluate preview events endpoint can be used instead.
Note that this is a POST endpoint rather than a GET endpoint because it employs a JSON body rather than query parameters.
Authorizations
API Keys can be issued in the Orb's web application.
Body
Response
OK
The response is of type object
.