Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
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);
Réponse200
{
  "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.
Paramètres de requête
from
string
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.
to
string
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.
timezone
string
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.
Contenu de la réponse
period
object
obligatoire
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
Afficher les attributs enfants
period.from
string
obligatoire
Inclusive start of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant on the hour grain. Historical starts are preserved; the maximum request length does not impose a historical cutoff.
period.to
string
obligatoire
Inclusive end of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant on the hour grain.
period.grain
string
obligatoire
The bucket grain of the series, either day or hour.
Possible values: day, hour
period.data_as_of
nullable string
Latest time reflected in the statistics. More recent events might not be included yet. Null when the freshness boundary is unavailable.
attribution
string
obligatoire
Always event_time for conversation statistics.
Possible values: accepted_time, event_time
data
array of object
obligatoire
One row per day or hour in chronological order. Buckets with no activity contain zero counts.
Afficher les attributs enfants
data.bucket
string
obligatoire
The day (YYYY-MM-DD) or hour (RFC 3339, on the hour) this point covers, matching the period's grain.
data.counts
object
obligatoire
Conversation lifecycle counts for the requested scope, attributed to when each event occurred. A conversation can start, reopen, and close more than once over its life, so started, reopened, and closed can each exceed conversations, the number of distinct conversations touched in scope. Very large counts are close estimates rather than exact tallies.
Afficher les attributs enfants
data.counts.started
integer
obligatoire
Count of conversation-started events in scope.
data.counts.reopened
integer
obligatoire
Count of conversation-reopened events in scope.
data.counts.closed
integer
obligatoire
Count of conversation-closed events in scope.
data.counts.conversations
integer
obligatoire
Distinct conversations with at least one lifecycle event in scope.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.

Comprendre le conceptShould I use a Bird SDK or call the API directly?Suivre le parcours d'apprentissageBuild your first integrationGuide d'implémentationSend your first email
Obtenir un guide d'implémentation