bird amb stats summary
Usage
Contoh kode
bird amb stats summary [flags]Description
Returns one aggregate row of outbound Apple Messages for Business counts and latency percentiles (p50, p95, and p99) for the requested period. Counts are attributed to the time each message was accepted, so a send failure recorded today counts against the day its message was accepted; period.data_as_of is the freshness boundary the rollups have reached.
Examples
Contoh kode
bird amb stats summaryOptions
| Name | Description |
|---|---|
| --business-id | Restrict the statistics to a single business. Mutually exclusive with the other dimension filters (message_kind, intent, group, category, tag); only one may be set per request. Matches the business_id key on a row of the per-business breakdown. |
| --category | Restrict the statistics to a single message category. Mutually exclusive with the other dimension filters (business_id, message_kind, intent, group, tag); only one may be set per request. Matches the category key on a row of the per-category breakdown. |
| --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. The comparison window carries any dimension filter set on the request, so a filtered comparison compares like with like. Possible values: previous_period. |
| --from | Inclusive start of the window: a calendar day (YYYY-MM-DD) or an RFC 3339 instant rounded down to the hour. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset such as +05:45 is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as to. When omitted, it defaults to 30 days before to for day windows or 168 hours (7 days) before to for hour windows. |
| --group | Restrict the statistics to a single entry-point group. Mutually exclusive with the other dimension filters (business_id, message_kind, intent, category, tag); only one may be set per request. Matches the group key on a row of the per-group breakdown. |
| --intent | Restrict the statistics to a single entry-point intent. Mutually exclusive with the other dimension filters (business_id, message_kind, group, category, tag); only one may be set per request. Matches the intent key on a row of the per-intent breakdown. |
| --message-kind | Restrict the statistics to a single message content kind. Mutually exclusive with the other dimension filters (business_id, intent, group, category, tag); only one may be set per request. Matches the message_kind key on a row of the per-content-kind breakdown. Possible values: text, attachment, rich_link, quick_reply, list_picker, time_picker, form, apple_pay, authenticate, imessage_app, interactive. |
| --response-schema | Print the fields this command returns, then exit |
| --tag | Restrict the statistics to a single tag. Use name to match any value of a tag, or name:value for a specific pair (for example campaign:spring_launch). Mutually exclusive with the other dimension filters (business_id, message_kind, intent, group, category); only one may be set per request. A row of the per-tag breakdown carries the same pair in its single tag key. |
| --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. The timezone parameter makes a calendar day local and rounds an instant down to the local hour. Omit timezone to use UTC. When timezone is set, a numeric UTC offset is rejected; use a calendar day or a Z (UTC) instant. This value must use the same form as from. When omitted, it defaults to today for day windows or the current hour for hour windows in that timezone. Day windows may not exceed 365 days; hour windows may not exceed 720 hours (30 days). |
Related
| Name | Description |
|---|---|
| bird amb stats by-business | Get outbound Apple Messages for Business statistics by business |
| bird amb stats by-category | Get outbound Apple Messages for Business statistics by category |
| bird amb stats by-error-code | Get outbound Apple Messages for Business statistics by error code |
| bird amb stats by-group | Get outbound Apple Messages for Business statistics by group |
| bird amb stats by-intent | Get outbound Apple Messages for Business statistics by intent |
| bird amb stats by-message-kind | Get outbound Apple Messages for Business statistics by message kind |
| bird amb stats by-tag | Get outbound Apple Messages for Business statistics by tag |
| bird amb stats daily | Get daily outbound Apple Messages for Business statistics |
| bird amb stats hourly | Get hourly outbound Apple Messages for Business statistics |
Sumber daya terkait
Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini. Sumber daya tersedia dalam bahasa Inggris.
Pahami konsepnyaShould I use a Bird SDK or call the API directly?Ikuti jalur pembelajaranBuild your first integrationPanduan implementasiSend your first email
Dapatkan ringkasan implementasi