Bird Sms Stats API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include sms-stats. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
16 operations
across 16 paths,
and defines 46 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.
The identity and technical contract details declared by the specification.
SMSInboundNumberStatsPoint
object
Received-message volume for one of your numbers.
2 properties
2 required
SMSErrorCode
string
Standardized failure reason: - invaliddestination: The number is unassigned, ported out, or malformed. - unreachable: The handset is off or outside coverage. -…
SMSStatsComparison
object
The same statistics for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two periods. Pre…
4 properties
4 required
ErrorDetail
object
2 properties
2 required
ErrorBody
object
11 properties
6 required
SMSInboundStatsComparisonDelta
object
The change from the preceding period to the requested one. The receivedpctchange field is a signed relative change, computed as (current - previous) / previous…
1 property
1 required
SMSStatsByCarrierResponse
object
Per-carrier breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
SMSInboundStatsPoint
object
One time bucket of received-message counts, attributed by arrival time.
2 properties
2 required
NextAction
object
5 properties
2 required
SMSCountryStatsPoint
object
Aggregate delivery and latency stats for a single destination country over the requested period.
4 properties
3 required
SMSInboundStatsResponse
object
Received-message time series. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
2 properties
2 required
SMSStatsSeriesPeriod
object
The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
4 properties
3 required
SMSLatencyStats
object
Latency percentiles in milliseconds for the requested scope: - processing: From acceptance to carrier handoff. - delivery: From carrier handoff to delivery con…
3 properties
SMSStatsLifecycleSortMetric
string
Metric to rank breakdown rows by, applied descending. Shared by the breakdowns whose rows carry lifecycle counts only, with no derived rates to sort on.
SMSStatsResponse
object
Time-series stats payload. period echoes the range and bucket grain the server computed against; data is one row per bucket in chronological order.
2 properties
2 required
SMSCarrierStatsPoint
object
Aggregate delivery and latency stats for a single delivery carrier over the requested period.
4 properties
3 required
SMSInboundCountryStatsPoint
object
Received-message volume for one country.
2 properties
2 required
SMSErrorCodeStatsPoint
object
Delivery and latency statistics for one standardized failure reason over the requested period.
4 properties
3 required
SMSStatsSortMetric
string
Metric to rank breakdown rows by, applied descending. Shared by the volume breakdowns whose rows carry the full delivery and latency block (originators, countr…
StatsGrain
string
The bucket grain of the series, either day or hour.
SMSInboundOperatorStatsPoint
object
Received-message volume for one mobile operator.
2 properties
2 required
SMSLatencyQuantiles
object
Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family. All three are null when no qualifying event contributed a measurement.
3 properties
3 required
SMSDeliveryCounts
object
SMS lifecycle counts for a time bucket. Counts use the message send time, so a message accepted on Monday and delivered on Tuesday counts in Monday's bucket. R…
7 properties
7 required
SMSStatsSummary
object
Single-row aggregate across the full requested period, covering SMS lifecycle counts plus the derived delivery and failure rates, and latency percentiles. Use…
4 properties
3 required
SMSStatsByStatusResponse
object
Lifecycle-status breakdown for the requested period, ordered by message count descending. Statuses with no activity are omitted.
3 properties
3 required
SMSInboundStatsByCountryResponse
object
Received-message volume broken down by country, ranked by volume.
3 properties
3 required
SMSStatsByCountryResponse
object
Per-country breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
SMSStatsByErrorCodeResponse
object
Per-error-code breakdown for the requested period, ranked by the sort metric (default failed) descending and capped at the requested limit (default 50, max 200…
3 properties
3 required
SMSStatsSummaryPeriod
object
The window the server actually computed against. The summary serves two window grains: calendar days (bounds are YYYY-MM-DD) and hours (bounds are RFC 3339 ins…
3 properties
2 required
SMSCategoryStatsPoint
object
Aggregate delivery and latency stats for a single message category over the requested period.
4 properties
3 required
Error
object
1 property
1 required
SMSStatsPoint
object
SMS lifecycle counts for one time bucket (a calendar day or hour), bucketed by send time. Every count in a bucket describes the messages accepted in it, regard…
2 properties
2 required
SMSStatusStatsPoint
object
The number of messages that ended the requested period in a single lifecycle status. This transposes the lifecycle counts into one row per status, so it carrie…
2 properties
2 required
SMSDeliveryStats
object
SMS lifecycle counts and rates for a whole period or breakdown. Counts use the message send time, so a later delivery stays attributed to the bucket in which t…
9 properties
9 required
SMSInboundStatsByNumberResponse
object
Received-message volume broken down by number, ranked by volume.
3 properties
3 required
SMSStatsByCategoryResponse
object
Per-category breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 200…
3 properties
3 required
SMSStatsComparisonDelta
object
Changes from the previous period. A pctchange value is the signed relative change (current - previous) / previous and is null when the previous count is zero.…
9 properties
9 required
SMSTagStatsPoint
object
Aggregate delivery and latency stats for a single tag (name:value) over the requested period.
4 properties
3 required
SMSInboundStatsSummaryResponse
object
Total received messages over the requested period.
3 properties
2 required
StatsTrendGrain
string
Bucket grain for a stats trend series.
SMSStatsByTagResponse
object
Per-tag breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 200).
3 properties
3 required
SMSInboundStatsByOperatorResponse
object
Received-message volume broken down by operator, ranked by volume.
3 properties
3 required
SMSStatsByOriginatorResponse
object
Per-originator breakdown for the requested period, ranked by the sort metric (default accepted) descending and capped at the requested limit (default 50, max 2…
3 properties
3 required
StatsComparePeriod
string
Set to previousperiod to also return the same figures for the immediately preceding window of equal length, plus the change between the two, so you can show "+…
SMSOriginatorStatsPoint
object
Aggregate delivery and latency stats for a single originator (the sender address messages were sent from) over the requested period.
4 properties
3 required
SMSInboundStatsComparison
object
The received-message count for the equal-length, inclusive period ending immediately before the requested start, together with the change between the two perio…
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bird publishes across the network.
