Get outbound SMS statistics by error code

GET

/v1/sms/stats/error-codes

const stats = await bird.sms.stats.byErrorCode({ from: "2026-05-01", to: "2026-05-31" });
for (const row of stats.data ?? []) {
  // The same value as the error_code filter on bird.sms.list.
  console.log(row.error_code, row.delivery);
}

stats = client.sms.stats.by_error_code(from_="2026-05-01", to="2026-05-31")
for row in stats.data or []:
    # The same value as the error_code filter on client.sms.list.
    print(row.error_code, row.delivery)

stats, err := client.Sms.Stats.ByErrorCode(context.Background(), bird.SmsStatsByErrorCodeParams{
	From: time.Now().AddDate(0, -1, 0),
	To:   time.Now(),
})
if err != nil {
	log.Fatal(err)
}
for _, row := range *stats.Data {
	// The same value as the error_code filter on Sms.List, so a row joins to its messages.
	fmt.Println(*row.ErrorCode, *row.Delivery.Failed)
}

$byErrorCode = $bird->sms->stats->byErrorCode(['from' => '2026-05-01', 'to' => '2026-05-31']);
foreach ($byErrorCode->getData() ?? [] as $row) {
    // The same value as the error_code filter on $bird->sms->list().
    echo $row->getErrorCode(), ' ', $row->getDelivery()?->getFailed(), PHP_EOL;
}

bird sms stats by-error-code

curl -X GET "https://us1.platform.bird.com/v1/sms/stats/error-codes" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=failed" \
  --url-query "limit=50" \
  --url-query "include_trend=false" \
  --url-query "trend_grain=daily"

Response200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "error_code": "invalid_destination",
      "delivery": {
        "accepted": 14820,
        "sent": 14810,
        "delivered": 14720,
        "undelivered": 60,
        "failed": 25,
        "rejected": 10,
        "expired": 5,
        "delivery_rate": 0.9932,
        "failure_rate": 0.0061
      },
      "latency": {
        "processing": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "delivery": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "total": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        }
      },
      "trend": [
        {
          "bucket": "2026-05-25",
          "delivery": {
            "accepted": 14820,
            "sent": 14810,
            "delivered": 14720,
            "undelivered": 60,
            "failed": 25,
            "rejected": 10,
            "expired": 5
          }
        }
      ]
    }
  ],
  "total": 17
}

Returns aggregate delivery and latency statistics grouped by normalized failure reason for the requested period. The grouping key matches the error_code filter on the message list, so each row maps directly to the affected messages rather than a raw carrier code. Rows are ranked by the sort metric (default failed) descending and capped at the requested limit (default 50, hard maximum 200).

Rows use send-time attribution. A delivery confirmed during the period for a message accepted earlier counts against the earlier period. A recent period therefore under-reports delivered while delivery reports are still arriving, and its counts grow as reports arrive. The maximum window is 365 days; requesting a longer range returns 422.

Query Parameters

fromstring

Start date (inclusive) in 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; with include_trend=true and trend_grain=hourly the default tightens to keep the window within the 720-hour trend cap.

tostring

End date (inclusive) in 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.

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.

sortstring

Metric to rank rows by, applied descending. Defaults to failed. Only lifecycle counts are sortable; this breakdown has no rates.

Possible values: accepted, sent, delivered, undelivered, failed, rejected, expired

limitinteger

Maximum number of error-code rows to return, ranked by the sort field descending.

include_trendboolean

When true, each row also carries a trend array: a short per-bucket lifecycle-count series for that row over the window. Returned only when limit is 50 or fewer and the window is at most 90 days (trend_grain=daily) or 720 hours (trend_grain=hourly); a larger request returns 422.

trend_grainstring

Bucket grain for the trend series. Has no effect unless include_trend=true.

Possible values: daily, hourly

Response Payload

period

object

required

The date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.

Show child attributes

period.from

string

required

Inclusive start of the window, as a calendar day (YYYY-MM-DD) or an RFC 3339 hour boundary.

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.

data

array of object

required

Error-code breakdown rows, ranked by the sort metric (default failed) descending. Empty when no delivery failures occurred in the period.

Show child attributes

data.error_code

string

required

Standardized failure reason this row aggregates. Matches the error_code message-list filter.

data.delivery

object

required

Show child attributes

data.delivery.accepted

integer

required

Distinct messages accepted for sending after admission checks. This is the denominator for delivery_rate and failure_rate.

data.delivery.sent

integer

required

Distinct messages handed off to the carrier for delivery.

data.delivery.delivered

integer

required

Distinct messages the carrier confirmed as delivered to the handset.

data.delivery.undelivered

integer

required

Distinct messages the carrier reported as not delivered.

data.delivery.failed

integer

required

Distinct messages that failed during sending.

data.delivery.rejected

integer

required

Distinct messages rejected before any send attempt, for example by sending policy or a message-generation failure.

data.delivery.expired

integer

required

Distinct messages that could not be delivered within their validity window and expired.

data.delivery.delivery_rate

nullable number

required

Share of accepted messages that were delivered, computed as delivered / accepted. Null when no messages were accepted in scope.

data.delivery.failure_rate

nullable number

required

Share of accepted messages that ultimately failed, computed as (undelivered + failed + expired) / accepted. Null when no messages were accepted in scope.

data.latency

object

required

Show child attributes

data.latency.processing

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.

Show child attributes

data.latency.processing.p50_ms

nullable integer

required

Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.processing.p95_ms

nullable integer

required

95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.processing.p99_ms

nullable integer

required

99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.delivery

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.

Show child attributes

data.latency.delivery.p50_ms

nullable integer

required

Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.delivery.p95_ms

nullable integer

required

95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.delivery.p99_ms

nullable integer

required

99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.total

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.

Show child attributes

data.latency.total.p50_ms

nullable integer

required

Median (50th percentile) latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.total.p95_ms

nullable integer

required

95th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.latency.total.p99_ms

nullable integer

required

99th percentile latency in milliseconds. Null when no qualifying event contributed a measurement.

data.trend

array of object

Per-bucket lifecycle counts for this error code, using trend_grain. Includes only buckets with activity. Present when include_trend=true.

Show child attributes

data.trend.bucket

string

required

The day (YYYY-MM-DD) or hour (RFC 3339, on the hour) this point covers, matching the period's grain.

data.trend.delivery

object

required

Show child attributes

data.trend.delivery.accepted

integer

required

Distinct messages accepted for sending after admission checks.

data.trend.delivery.sent

integer

required

Distinct messages handed off to the carrier for delivery.

data.trend.delivery.delivered

integer

required

Distinct messages the carrier confirmed as delivered to the handset.

data.trend.delivery.undelivered

integer

required

Distinct messages the carrier reported as not delivered.

data.trend.delivery.failed

integer

required

Distinct messages that failed during sending.

data.trend.delivery.rejected

integer

required

Distinct messages rejected before any send attempt, for example by sending policy or a message-generation failure.

data.trend.delivery.expired

integer

required

Distinct messages that could not be delivered within their validity window and expired.

total

integer

required

Total number of distinct error codes with activity in the period, regardless of limit. When it exceeds the number of rows returned, the ranking was capped; raise limit (up to 200) or narrow the window to see more.

Continue with the documentation, guides and examples for this topic.

Try the practice and get an implementation brief

const stats = await bird.sms.stats.byErrorCode({ from: "2026-05-01", to: "2026-05-31" });
for (const row of stats.data ?? []) {
  // The same value as the error_code filter on bird.sms.list.
  console.log(row.error_code, row.delivery);
}

stats = client.sms.stats.by_error_code(from_="2026-05-01", to="2026-05-31")
for row in stats.data or []:
    # The same value as the error_code filter on client.sms.list.
    print(row.error_code, row.delivery)

stats, err := client.Sms.Stats.ByErrorCode(context.Background(), bird.SmsStatsByErrorCodeParams{
	From: time.Now().AddDate(0, -1, 0),
	To:   time.Now(),
})
if err != nil {
	log.Fatal(err)
}
for _, row := range *stats.Data {
	// The same value as the error_code filter on Sms.List, so a row joins to its messages.
	fmt.Println(*row.ErrorCode, *row.Delivery.Failed)
}

$byErrorCode = $bird->sms->stats->byErrorCode(['from' => '2026-05-01', 'to' => '2026-05-31']);
foreach ($byErrorCode->getData() ?? [] as $row) {
    // The same value as the error_code filter on $bird->sms->list().
    echo $row->getErrorCode(), ' ', $row->getDelivery()?->getFailed(), PHP_EOL;
}

bird sms stats by-error-code

curl -X GET "https://us1.platform.bird.com/v1/sms/stats/error-codes" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=failed" \
  --url-query "limit=50" \
  --url-query "include_trend=false" \
  --url-query "trend_grain=daily"

Response200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "error_code": "invalid_destination",
      "delivery": {
        "accepted": 14820,
        "sent": 14810,
        "delivered": 14720,
        "undelivered": 60,
        "failed": 25,
        "rejected": 10,
        "expired": 5,
        "delivery_rate": 0.9932,
        "failure_rate": 0.0061
      },
      "latency": {
        "processing": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "delivery": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        },
        "total": {
          "p50_ms": 420,
          "p95_ms": 1820,
          "p99_ms": 4920
        }
      },
      "trend": [
        {
          "bucket": "2026-05-25",
          "delivery": {
            "accepted": 14820,
            "sent": 14810,
            "delivered": 14720,
            "undelivered": 60,
            "failed": 25,
            "rejected": 10,
            "expired": 5
          }
        }
      ]
    }
  ],
  "total": 17
}

Get outbound SMS statistics by error code

Query Parameters

Response Payload

Related resources