Daily received-message counts
GET
/v1/sms/stats/inbound/daily
const stats = await bird.sms.stats.inbound.daily({ from: "2026-05-01", to: "2026-05-31" });
for (const point of stats.data ?? []) {
console.log(point.bucket, point.received);
}stats = client.sms.stats.inbound.daily(from_="2026-05-01", to="2026-05-31")
for point in stats.data or []:
print(point.bucket, point.received)series, err := client.Sms.Stats.Inbound.Daily(context.Background(), bird.SmsStatsInboundDailyParams{
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.Received)
}$inboundDaily = $bird->sms->stats->inbound->daily(['from' => '2026-05-01', 'to' => '2026-05-31']);
foreach ($inboundDaily->getData() ?? [] as $point) {
echo $point->getBucket(), ' ', $point->getReceived(), PHP_EOL;
}bird sms stats inbound dailycurl -X GET "https://us1.platform.bird.com/v1/sms/stats/inbound/daily" \
-H "Authorization: Bearer $TOKEN"Returns the number of messages your numbers received, one row per calendar day.
Rows are bucketed by the time the carrier received the message. Days with no messages are still included, with a count of zero, so a chart has no gaps.
A row carries a count and nothing else. A received message has one state, so there is no lifecycle to break down and no delivery latency to report; the send statistics endpoints cover those for messages you send.
The maximum window is 365 days; a longer range returns 422. Set timezone to bucket rows by your local calendar day instead of UTC.
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). 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). Defaults to today in that timezone when omitted. Window may not exceed 365 days.
timezone
string
IANA timezone identifier (for example Asia/Kathmandu) to report in; defaults to UTC. Day and hour boundaries and the default window when from and to are omitted both follow it, so a calendar-day from or to names a local day. A from or to carrying its own UTC offset is rejected while this is set: pass a calendar day or a Z instant.
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 rounded to the hour on the hour grain.
period.to
string
obligatoire
Inclusive end of the window. A calendar day (YYYY-MM-DD) on the day grain, an RFC 3339 instant rounded to the hour 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
The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response is near-real-time but not live; use this field to label data freshness rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
data
array of object
obligatoire
One row per bucket (day or hour, per the grain) in the period, in chronological order. Buckets with no activity are included with a count of zero, so the series charts continuously without client-side gap handling.
Afficher les attributs enfants
data.bucket
string
obligatoire
Start of the bucket this row covers, as a calendar day (YYYY-MM-DD) for the daily series or an hour boundary (RFC 3339) for the hourly one.
data.received
integer
obligatoire
Distinct messages received in this bucket, counted by the time the carrier received them.