bird voice stats by-trunk
Usage
Code example
bird voice stats by-trunk [flags]Description
Voice stats grouped by SIP trunk, ranked by sort (default total_calls) and capped at limit (default 50, max 200); the response's total tells a capped ranking from a complete one. This is the axis that answers which trunk is degraded, so compare asr and short_call_rate across rows rather than reading one in isolation. trunk_name is resolved as the response is built, and a null trunk_id is the row for calls that used no trunk, such as Verify voice calls.
Examples
Code example
bird voice stats by-trunkOptions
| Name | Description |
|---|---|
| --destination | When set, limits the statistics to calls to this destination country, as an ISO 3166-1 alpha-2 code. This is the drill-down from a row of the destination breakdown, and it matches the same country that breakdown reports for a call. |
| --direction | When set, limits the statistics to call legs in this direction. Omit to include all legs. Possible values: inbound, outbound. |
| --from | Start date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to 30 days before to when omitted. |
| --limit <n> | Maximum number of rows to return, ranked by the sort metric descending. The response's total reports how many rows existed before this cap. |
| --own-number | When set, limits the statistics to calls on this number of yours, in E.164 form. It matches your own end of the call, which is the caller on an outbound leg and the recipient on an inbound one. It is named apart from the call log's number because that one matches either party, where this one is always your end. A number that has no standard form matches exactly as the network presented it, so an unusual one is still searchable. A value that matches no call gives an empty result rather than an error, as any unmatched filter does. To narrow by the party you called instead, use destination. |
| --response-schema | Print the fields this command returns, then exit |
| --short-call-threshold-ms <n> | Duration in milliseconds below which an answered call counts toward short_calls. The default of 30 seconds is a convention rather than a property of the network, so set it to whatever your own definition of a call too short to have been useful is. Every response echoes the value it used, so a stored figure can always be read against the definition that produced it. |
| --sort | Which metric ranks the breakdown rows, always descending. Defaults to total_calls. Possible values: total_calls, answered_calls, asr, acd_ms. |
| --status <value>… | When set, limits the statistics to calls with one of these statuses, comma-separated. Four of the vocabulary's values match nothing here, for three different reasons: these statistics cover ended calls only, so ringing and in_progress are outside their scope; busy and canceled are not emitted yet and arrive as failed today; and no call is stored as other, which the outcome split uses for a status it does not name. The five that do match are answered, no_answer, failed, rejected and unknown. Possible values: answered, no_answer, busy, canceled, failed, rejected, unknown, ringing, in_progress. |
| --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 | End date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to today in that timezone when omitted. Window may not exceed 365 days. |
| --trunk-id | When set, limits the statistics to calls carried by this SIP trunk. This is the drill-down from a row of the trunk breakdown. Calls that used no trunk, such as Verify voice calls, match no value here and are excluded whenever it is set. |
Related
| Name | Description |
|---|---|
| bird voice stats by-country | Get Voice statistics by destination country |
| bird voice stats by-hour-of-day | Get Voice statistics by hour of day |
| bird voice stats by-number | Get Voice statistics by own number |
| bird voice stats by-number-country | Get Voice statistics by own number country |
| bird voice stats by-response-code | Get Voice statistics by response code |
| bird voice stats by-weekday | Get Voice statistics by weekday |
| bird voice stats daily | Get daily Voice statistics |
| bird voice stats hourly | Get hourly Voice statistics |
| bird voice stats summary | Get aggregate Voice statistics |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Understand the conceptWhat is a voice API?Explore the capabilityVoiceImplementation guideVoice overview
Get an implementation brief