Sign inGet Started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

Get daily Apple Messages for Business conversation statistics

GET
/v1/amb/stats/conversations/daily
const result = await bird.amb.stats.conversations.daily();
console.log(result);
Odpowiedź200
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "attribution": "accepted_time",
  "data": [
    {
      "bucket": "2026-05-25",
      "counts": {
        "started": 210,
        "reopened": 34,
        "closed": 198,
        "conversations": 205
      }
    }
  ]
}

Returns one row of Apple Messages for Business conversation lifecycle counts (started, reopened, closed, conversations) per calendar day for the workspace, gap-filled so a silent day is a zero row rather than a missing one. Every row is attributed to the day the lifecycle event occurred, not to any earlier outbound message. A conversation can be reopened and closed more than once, so started, reopened, and closed need not sum to conversations within a row, and any one of them can exceed it.

from and to are optional calendar days (YYYY-MM-DD), defaulting to the trailing 30 days. The maximum window is 365 days; a longer range returns 422. Set timezone to report rows by your local calendar day. Historical dates are supported within the maximum window length; the requested dates are not shifted forward.

Parametry zapytania

fromstring

Start date (inclusive), YYYY-MM-DD. Interpreted as a calendar day in timezone (a UTC day when timezone is omitted). The window may not exceed 365 days. Defaults to 30 days before to when omitted.

tostring

End date (inclusive), YYYY-MM-DD. Interpreted as a calendar day in timezone (a UTC day when timezone is omitted). The window may not exceed 365 days. Defaults to today in that timezone when omitted.

timezonestring

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.

Treść odpowiedzi

period
object
wymagane

The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.

Pokaż atrybuty podrzędne
attribution
string
wymagane

Always event_time for conversation statistics.

Possible values: accepted_time, event_time

data
array of object
wymagane

One row per day or hour in chronological order. Buckets with no activity contain zero counts.

Pokaż atrybuty podrzędne

Powiązane zasoby

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy