bird voice stats summary
Usage
Code example
bird voice stats summary [flags]Description
Get one aggregate row of call-quality and duration metrics. total_duration_ms covers every leg; total_billable_ms covers answered legs. Use matching day or RFC 3339 bounds, and set compare=previous_period for changes against the preceding window. Use bird voice stats daily or bird voice stats hourly for a series, and the country or response-code breakdowns to locate failures.
Procedure
Step 3 of 8 of "Watch voice calls and find out why one was refused". Previous: bird voice get. Next: bird voice stats by-country.
Examples
Code example
bird voice stats summaryOptions
| Name | Description |
|---|---|
| --compare | Set to previous_period to also include the same statistics for the immediately preceding window of equal length, plus the change between the two, so you can show '+X% vs last period' without a second request. Possible values: previous_period. |
| --direction | When set, limits the statistics to call legs in this direction. Omit to include all legs. Possible values: inbound, outbound. |
| --from | Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant (rounded down to the hour). Interpreted in timezone (a calendar day names a local day and an instant is rounded down to the local hour), or in UTC when timezone is omitted. A numeric UTC offset (for example +05:45) is rejected when timezone is set; use a calendar day or a Z (UTC) instant. Must use the same form as to. Defaults to 30 days before to for day windows, or 168 hours (7 days) before to for hour windows, when omitted. |
| --response-schema | Print the fields this command returns, then exit |
| --timezone | IANA timezone identifier used to group statistics, for example Asia/Kathmandu. The default is UTC. Day and hour boundaries, including the default window when from and to are omitted, follow this timezone. When this parameter is set, pass from and to as calendar days or Z instants instead of timestamps with explicit UTC offsets. |
| --to | Inclusive end of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant (rounded down to the hour). Interpreted in timezone (a calendar day names a local day and an instant is rounded down to the local hour), or in UTC when timezone is omitted. A numeric UTC offset is rejected when timezone is set; use a calendar day or a Z (UTC) instant. Must use the same form as from. Defaults to today for day windows, or the current hour for hour windows, in that timezone, when omitted. Day windows may not exceed 365 days; hour windows may not exceed 720 hours (30 days). |
Related
| Name | Description |
|---|---|
| bird voice stats by-country | Get Voice statistics by country |
| bird voice stats by-response-code | Get Voice statistics by response code |
| bird voice stats daily | Get daily Voice statistics |
| bird voice stats hourly | Get hourly Voice statistics |