Get daily outbound WhatsApp statistics

GET

/v1/whatsapp/stats/daily

const stats = await bird.whatsapp.stats.daily({ from: "2026-08-01", to: "2026-08-31" });
for (const point of stats.data ?? []) {
  console.log(point.bucket, point.delivery);
}

stats = client.whatsapp.stats.daily(from_="2026-08-01", to="2026-08-31")
for point in stats.data or []:
    print(point.bucket, point.delivery)

series, err := client.Whatsapp.Stats.Daily(context.Background(), bird.WhatsappStatsDailyParams{
	From: time.Now().AddDate(0, 0, -7),
	To:   time.Now(),
})
if err != nil {
	log.Fatal(err)
}
for _, point := range *series.Data {
	fmt.Println(*point.Bucket, *point.Delivery.Accepted)
}

$daily = $bird->whatsapp->stats->daily(['from' => '2026-08-01', 'to' => '2026-08-31']);
foreach ($daily->getData() ?? [] as $point) {
    echo $point->getBucket(), ' ', $point->getDelivery()?->getAccepted(), PHP_EOL;
}

bird whatsapp stats daily

curl -X GET "https://us1.platform.bird.com/v1/whatsapp/stats/daily" \
  -H "Authorization: Bearer $TOKEN"

Réponse200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "bucket": "2026-05-25",
      "delivery": {
        "accepted": 4820,
        "sent": 4810,
        "delivered": 4720,
        "failed": 25,
        "rejected": 412
      },
      "engagement": {
        "read": 3105
      },
      "latency": {
        "processing": {
          "p50_ms": 610,
          "p95_ms": 2140,
          "p99_ms": 5380
        },
        "delivery": {
          "p50_ms": 1530,
          "p95_ms": 6820,
          "p99_ms": 18400
        },
        "total": {
          "p50_ms": 2180,
          "p95_ms": 9060,
          "p99_ms": 24300
        }
      }
    }
  ]
}

Returns one row of aggregate WhatsApp statistics per calendar day for the workspace. Rows use send-time attribution, so a delivery confirmation received on Wednesday for a message accepted the prior Monday is counted in Monday's row. Recent rows can under-report delivered while delivery reports arrive. Days with no activity are included with zero counts.

Each row carries lifecycle counts (accepted, sent, delivered, read, failed) and its own latency percentiles; delivery, failure, and read rates are whole-window aggregates available from the summary endpoint instead. 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.

Set at most one dimension filter (template, category, phone_number, tag) to restrict the statistics to that dimension's value; setting more than one returns 422.

Paramètres de requête

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.

templatestring

Restricts the statistics to one template, identified by its ID (wat_…) or slug. Mutually exclusive with the other dimension filters (category, phone_number, tag); only one may be set per request. An ID matches the template_id key on a row of the per-template breakdown; a slug is accepted for callers that predate that key and resolves to the same messages.

categorystring

Restrict the statistics to a single template category. Mutually exclusive with the other dimension filters (template, phone_number, tag); only one may be set per request. Matches the category key on a row of the per-category breakdown.

Possible values (may grow over time): authentication, utility, marketing

phone_numberstring

Restrict the statistics to a single business sender phone number, in E.164 form. Mutually exclusive with the other dimension filters (template, category, tag); only one may be set per request. Matches the phone_number key on a row of the per-phone-number breakdown.

tagstring

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 (template, category, phone_number); only one may be set per request. A row of the per-tag breakdown carries the same pair in its single tag key.

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

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.delivery

object

obligatoire

Afficher les attributs enfants

data.engagement

object

obligatoire

Afficher les attributs enfants

data.latency

object

obligatoire

Afficher les attributs enfants

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation

const stats = await bird.whatsapp.stats.daily({ from: "2026-08-01", to: "2026-08-31" });
for (const point of stats.data ?? []) {
  console.log(point.bucket, point.delivery);
}

stats = client.whatsapp.stats.daily(from_="2026-08-01", to="2026-08-31")
for point in stats.data or []:
    print(point.bucket, point.delivery)

series, err := client.Whatsapp.Stats.Daily(context.Background(), bird.WhatsappStatsDailyParams{
	From: time.Now().AddDate(0, 0, -7),
	To:   time.Now(),
})
if err != nil {
	log.Fatal(err)
}
for _, point := range *series.Data {
	fmt.Println(*point.Bucket, *point.Delivery.Accepted)
}

$daily = $bird->whatsapp->stats->daily(['from' => '2026-08-01', 'to' => '2026-08-31']);
foreach ($daily->getData() ?? [] as $point) {
    echo $point->getBucket(), ' ', $point->getDelivery()?->getAccepted(), PHP_EOL;
}

bird whatsapp stats daily

curl -X GET "https://us1.platform.bird.com/v1/whatsapp/stats/daily" \
  -H "Authorization: Bearer $TOKEN"

Réponse200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "bucket": "2026-05-25",
      "delivery": {
        "accepted": 4820,
        "sent": 4810,
        "delivered": 4720,
        "failed": 25,
        "rejected": 412
      },
      "engagement": {
        "read": 3105
      },
      "latency": {
        "processing": {
          "p50_ms": 610,
          "p95_ms": 2140,
          "p99_ms": 5380
        },
        "delivery": {
          "p50_ms": 1530,
          "p95_ms": 6820,
          "p99_ms": 18400
        },
        "total": {
          "p50_ms": 2180,
          "p95_ms": 9060,
          "p99_ms": 24300
        }
      }
    }
  ]
}

Get daily outbound WhatsApp statistics

Paramètres de requête

Contenu de la réponse

Ressources associées