# Get aggregate Apple Messages for Business conversation statistics

`GET /v1/amb/stats/conversations/summary`

Returns one aggregate row of Apple Messages for Business conversation lifecycle counts (`started`, `reopened`, `closed`, `conversations`) for the requested period. Rows are attributed to when 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`, and any one of them can exceed it. `period.data_as_of` is the freshness boundary the rollups have reached.

`from` and `to` must both be calendar days or RFC 3339 instants. Day windows cover up to 365 whole days. Instant bounds round down to the hour, remain inclusive, and may span up to 720 hours. Mixing the forms returns `422`. Set `timezone` for local boundaries. Historical dates are supported within the maximum window length; the requested dates are not shifted forward.

Use `compare=previous_period` to include the preceding equal-length window and the change between the two.

## Code samples

**TypeScript**

```ts
const result = await bird.amb.stats.conversations.summary();
console.log(result);
```

Examples: [TypeScript](/docs/api/reference/get-amb-conversation-stats-summary.ts.md) · [Python](/docs/api/reference/get-amb-conversation-stats-summary.py.md) · [Go](/docs/api/reference/get-amb-conversation-stats-summary.go.md) · [PHP](/docs/api/reference/get-amb-conversation-stats-summary.php.md) · [CLI](/docs/api/reference/get-amb-conversation-stats-summary.cli.md) · [MCP](/docs/api/reference/get-amb-conversation-stats-summary.mcp.md) · [cURL](/docs/api/reference/get-amb-conversation-stats-summary.curl.md)

## Example response `200`

```json
{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "attribution": "accepted_time",
  "counts": {
    "started": 210,
    "reopened": 34,
    "closed": 198,
    "conversations": 205
  },
  "comparison": {
    "period": {
      "from": "2026-05-01",
      "to": "2026-05-25",
      "data_as_of": "2026-05-25T14:03:10Z"
    },
    "counts": {
      "started": 210,
      "reopened": 34,
      "closed": 198,
      "conversations": 205
    },
    "delta": {
      "started_pct_change": 0.22,
      "reopened_pct_change": -0.05,
      "closed_pct_change": 0.19,
      "conversations_pct_change": 0.21
    }
  }
}
```

## Query parameters

- `from` (string): 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.
- `to` (string): 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).
- `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.
- `compare` (string)

  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`

## Response body

- `period` (object, required): The window the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
- `period.from` (string, required): Inclusive start of the window, as a calendar day (`YYYY-MM-DD`) or an RFC 3339 hour boundary. Historical starts are preserved; the maximum request length does not impose a historical cutoff.
- `period.to` (string, required): Inclusive end of the window, as a calendar day (`YYYY-MM-DD`) or an RFC 3339 hour boundary.
- `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, required)

  Always `event_time` for conversation statistics.

  Possible values: `accepted_time`, `event_time`
- `counts` (object, required): 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.
- `counts.started` (integer, required): Count of conversation-started events in scope.
- `counts.reopened` (integer, required): Count of conversation-reopened events in scope.
- `counts.closed` (integer, required): Count of conversation-closed events in scope.
- `counts.conversations` (integer, required): Distinct conversations with at least one lifecycle event in scope.
- `comparison` (object): The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two periods. Present only when `compare=previous_period` is requested. The change is already computed, so a percentage difference needs no second request.
- `comparison.period` (object, required): The preceding window these comparison figures cover, the equal-length window ending immediately before the requested start (the prior day for day windows, the prior hour for hour windows).
- `comparison.period.from` (string, required): Inclusive start of the window, as a calendar day (`YYYY-MM-DD`) or an RFC 3339 hour boundary. Historical starts are preserved; the maximum request length does not impose a historical cutoff.
- `comparison.period.to` (string, required): Inclusive end of the window, as a calendar day (`YYYY-MM-DD`) or an RFC 3339 hour boundary.
- `comparison.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.
- `comparison.counts` (object, required): 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.
- `comparison.counts.started` (integer, required): Count of conversation-started events in scope.
- `comparison.counts.reopened` (integer, required): Count of conversation-reopened events in scope.
- `comparison.counts.closed` (integer, required): Count of conversation-closed events in scope.
- `comparison.counts.conversations` (integer, required): Distinct conversations with at least one lifecycle event in scope.
- `comparison.delta` (object, required): Changes from the previous period. Each value is the signed relative change `(current - previous) / previous` and is null when the previous count is zero.
- `comparison.delta.started_pct_change` (nullable number, required): Relative change in conversation starts (`counts.started`) versus the previous period, as a signed fraction. Null when the previous period had none.
- `comparison.delta.reopened_pct_change` (nullable number, required): Relative change in conversation reopens (`counts.reopened`) versus the previous period, as a signed fraction. Null when the previous period had none.
- `comparison.delta.closed_pct_change` (nullable number, required): Relative change in conversation closes (`counts.closed`) versus the previous period, as a signed fraction. Null when the previous period had none.
- `comparison.delta.conversations_pct_change` (nullable number, required): Relative change in distinct conversations touched (`counts.conversations`) versus the previous period, as a signed fraction. Null when the previous period had none.

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)
