Get hourly outbound SMS statistics

GET

/v1/sms/stats/hourly

const stats = await bird.sms.stats.hourly({
  from: "2026-05-30T00:00:00Z",
  to: "2026-05-31T00:00:00Z",
});
for (const point of stats.data ?? []) {
  console.log(point.bucket, point.delivery);
}

stats = client.sms.stats.hourly(from_="2026-05-30T00:00:00Z", to="2026-05-31T00:00:00Z")
for point in stats.data or []:
    print(point.bucket, point.delivery)

series, err := client.Sms.Stats.Hourly(context.Background(), bird.SmsStatsHourlyParams{
	From: time.Now().Add(-24 * time.Hour),
	To:   time.Now(),
})
if err != nil {
	log.Fatal(err)
}
for _, point := range *series.Data {
	fmt.Println(*point.Bucket, *point.Delivery.Accepted)
}

$hourly = $bird->sms->stats->hourly(['from' => '2026-05-30T00:00:00Z', 'to' => '2026-05-31T00:00:00Z']);
foreach ($hourly->getData() ?? [] as $point) {
    echo $point->getBucket(), PHP_EOL;
}

bird sms stats hourly

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

Réponse200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-31",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "bucket": "2026-05-25",
      "delivery": {
        "accepted": 14820,
        "sent": 14810,
        "delivered": 14720,
        "undelivered": 60,
        "failed": 25,
        "rejected": 10,
        "expired": 5
      }
    }
  ]
}

Returns one row of SMS lifecycle counts per hour. Rows use send-time attribution, so a delivery confirmation is counted in the hour when its message was accepted. Recent rows can under-report delivered while delivery reports arrive.

Rates and latency are whole-window aggregates available from the summary endpoint. Set timezone for local hours instead of UTC, including zones with sub-hour offsets.

A request may span up to 30 days (720 rows). from and to are ISO 8601 instants; each bound rounds down to the hour and remains inclusive. An excessive or reversed window returns 422. Use the daily endpoint for longer ranges.

Paramètres de requête

fromstring

Start of the window (ISO 8601 instant), rounded down to the start of its hour and included. The boundary uses the local hour when timezone is set and the UTC hour otherwise. When timezone is set, a numeric UTC offset such as +05:45 is rejected; use a Z (UTC) instant. Defaults to 7 days before to when omitted.

tostring

End of the window (ISO 8601 instant), rounded down to the start of its hour and included. The boundary uses the local hour when timezone is set and the UTC hour otherwise, so both bounds are inclusive. When timezone is set, a numeric UTC offset is rejected; use a Z (UTC) instant. Defaults to the current hour when omitted. The window may not exceed 30 days (720 hours).

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.

originatorstring

Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters (country, category, carrier); only one may be set per request. Matches the message from.

countrystring

Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters (originator, category, carrier); only one may be set per request.

categorystring

Restrict the statistics to a single category. Mutually exclusive with the other dimension filters (originator, country, carrier); only one may be set per request.

carrierstring

Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters (originator, country, category); only one may be set per request.

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

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

Essayez la pratique et obtenez un guide d'implémentation

const stats = await bird.sms.stats.hourly({
  from: "2026-05-30T00:00:00Z",
  to: "2026-05-31T00:00:00Z",
});
for (const point of stats.data ?? []) {
  console.log(point.bucket, point.delivery);
}

stats = client.sms.stats.hourly(from_="2026-05-30T00:00:00Z", to="2026-05-31T00:00:00Z")
for point in stats.data or []:
    print(point.bucket, point.delivery)

series, err := client.Sms.Stats.Hourly(context.Background(), bird.SmsStatsHourlyParams{
	From: time.Now().Add(-24 * time.Hour),
	To:   time.Now(),
})
if err != nil {
	log.Fatal(err)
}
for _, point := range *series.Data {
	fmt.Println(*point.Bucket, *point.Delivery.Accepted)
}

$hourly = $bird->sms->stats->hourly(['from' => '2026-05-30T00:00:00Z', 'to' => '2026-05-31T00:00:00Z']);
foreach ($hourly->getData() ?? [] as $point) {
    echo $point->getBucket(), PHP_EOL;
}

bird sms stats hourly

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

Réponse200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-31",
    "grain": "day",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "bucket": "2026-05-25",
      "delivery": {
        "accepted": 14820,
        "sent": 14810,
        "delivered": 14720,
        "undelivered": 60,
        "failed": 25,
        "rejected": 10,
        "expired": 5
      }
    }
  ]
}

Get hourly outbound SMS statistics

Paramètres de requête

Contenu de la réponse

Ressources associées