CostReport
The estimated cost of the Calls of a window, rated from the price list at read time: the total, the means per Call and per minute, and the share of each stage. An estimate from list prices, not a bill.
An object with 19 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
by_agent_version | array of CostByAgentVersion | no | The charge per billable minute by Agent version. Added in 1.57.0 (roadmap slice 2.11); absent from an older api, which a reader treats as unknown. |
by_lane | array of CostByLane | no | The amount by lane. Added in 1.57.0 (roadmap slice 2.11); absent from an older api, which a reader treats as unknown. |
by_provider | array of CostByProvider | no | The amount by Provider or party, largest first. Added in 1.57.0 (roadmap slice 2.11); absent from an older api, which a reader treats as unknown. |
by_stage | array of CostReportStage | yes | One item per cost stage, in the order of CostStage; 0 for a stage with no line. |
calls | integer | yes | Ended Calls in the window. |
currency | "USD" | yes | |
estimate | true | yes | Always true: the figures are rated from list prices at read time and are not a bill. |
from | string | yes | The start of the window, RFC 3339. |
granularity | AnalyticsGranularity | no | The rollup rows read. Added in 1.57.0 (roadmap slice 2.11); absent from an older api, which a reader treats as unknown. |
groups | array of CostGroup | no | One item per group of group_by; empty when the read named none. Added in 1.57.0 (roadmap slice 2.11); absent from an older api, which a reader treats as unknown. |
mean_per_call_micros | number or null | yes | The mean estimate per rated Call in micro-USD; null when no Call was rated. |
mean_per_minute_micros | number or null | yes | The rated total per Call minute of the rated Calls in micro-USD; null when no Call was rated or none had a duration. |
object | "cost_report" | yes | |
per_outcome | CostPerOutcome or null | no | Cost per Outcome value; null when no counted Call has a rollup Outcome value. Added in 1.57.0 (roadmap slice 2.11); absent from an older api, which a reader treats as unknown. |
price_list_version | string | yes | The version of the price list the estimate used; a date in 1.5.0. |
rated_calls | integer | yes | Ended Calls whose estimate is complete (every line priced); only these count towards the amounts. |
to | string | yes | The end of the window, RFC 3339. |
total_micros | integer | yes | The rated total of the rated_calls in whole micro-USD. |
window | AnalyticsWindow | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.