Get statistics by template

GET

/v1/email/stats/templates

const { data } = await bird.email.stats.byTemplate({
  from: "2026-05-01",
  to: "2026-05-31",
  sort: "open_rate",
  limit: 25,
});
for (const row of data) console.log(row.template_id, row.engagement.open_rate);

stats = client.email.stats.by_template(from_="2026-05-01", to="2026-05-25")
for row in stats.data:
    print(row)

stats, err := client.Email.Stats.ByTemplate(context.Background(), bird.EmailStatsByTemplateParams{})
if err != nil {
	log.Fatal(err)
}
fmt.Println(stats.Data)

$stats = $bird->email->stats->byTemplate([
    'from' => '2026-05-01',
    'to' => '2026-05-31',
    'sort' => 'open_rate',
    'limit' => 25,
]);
foreach ($stats->getData() ?? [] as $row) {
    echo $row->getTemplateId(), ' ', $row->getEngagement()?->getOpenRate(), "\n";
}

bird email stats by-template

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

Antwort200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "template_id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
      "delivery": {
        "accepted": 14820,
        "processed": 14810,
        "delivered": 14720,
        "bounced": 90,
        "bounces": {
          "hard": 12410,
          "soft": 14290,
          "admin": 410,
          "block": 920,
          "undetermined": 80,
          "hard_rate": 0.454,
          "soft_rate": 0.523,
          "admin_rate": 0.015,
          "block_rate": 0.0337,
          "undetermined_rate": 0.0029
        },
        "complained": 3,
        "deferred": 14,
        "rejected": 10,
        "oob_bounces": 2,
        "effective_delivered": 14718,
        "all_bounces": 92,
        "oob_rate": 0.00014,
        "delivery_rate": 0.9939,
        "bounce_rate": 0.0061,
        "complaint_rate": 0.0002
      },
      "engagement": {
        "opens": 5420,
        "opens_non_prefetched": 3210,
        "unique_opens": 3640,
        "unique_opens_non_prefetched": 2480,
        "clicks": 924,
        "unique_clicks": 621,
        "unsubscribes": 12,
        "open_rate": 0.1683,
        "click_rate": 0.0422,
        "unsubscribe_rate": 0.0009
      },
      "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-12"
        }
      ]
    }
  ],
  "total": 42,
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns aggregate delivery and engagement counts grouped by the template each message was sent with, so a template's deliverability and engagement can be compared side by side. Attribution is by the template used at send time; only messages sent with a template appear here, so a workspace that has sent none returns an empty list rather than an error. Each row is keyed by the template ID (emt_…); a template deleted after sending still appears by its ID.

Rows are ranked by the sort metric (default processed) descending and paginated with the requested limit (default 50, hard maximum 200). Rows are computed against event time (not send time), so engagement received during the period for messages sent earlier is included.

The maximum window is 365 days; requesting a longer range returns 422.

Abfrageparameter

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

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 29 days before to, keeping the defaulted 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.

categorystring

Not supported on breakdown endpoints; supplying it returns 422. To compare categories use GET /v1/email/stats/categories; the summary, daily, and hourly statistics accept category as a filter.

sortstring

Metric to rank rows by, applied descending. Any count or rate in the response may be used; rows whose rate is undefined (zero denominator) sort last. Defaults to processed.

Possible values: processed, delivered, bounced, complained, deferred, rejected, oob_bounces, bounces.hard, bounces.soft, bounces.admin, bounces.block, bounces.undetermined, opens, opens_non_prefetched, unique_opens, unique_opens_non_prefetched, clicks, unique_clicks, unsubscribes, delivery_rate, bounce_rate, complaint_rate, open_rate, click_rate, unsubscribe_rate, bounces.hard_rate, bounces.soft_rate, bounces.admin_rate, bounces.block_rate, bounces.undetermined_rate

limitinteger

Maximum number of template rows to return, ranked by the sort field descending.

include_trendboolean

When true, each row also has a trend array: a short per-bucket series of that template's delivery and engagement rates 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. When from is omitted and trend_grain=hourly, the default start tightens to 29 days before to, keeping the window inside 720 hours, so a request built entirely from defaults always fits the cap.

trend_grainstring

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

Possible values: daily, hourly

Antwort-Payload

period

object

erforderlich

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

Untergeordnete Attribute anzeigen

data

array of object

erforderlich

Template breakdown rows, ranked by the sort metric (default processed) descending. Empty when no messages were sent with a template in the period.

Untergeordnete Attribute anzeigen

data.template_id

string

erforderlich

The template this row is about, using the same id the email template endpoints return. Only messages sent with a template appear in this breakdown at all. If the template was deleted after it was used to send, this row still appears, keyed by that same id.

data.delivery

object

erforderlich

Untergeordnete Attribute anzeigen

data.engagement

object

erforderlich

Untergeordnete Attribute anzeigen

data.latency

object

erforderlich

Untergeordnete Attribute anzeigen

data.latency.processing

object

Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contributed a measurement.

Untergeordnete Attribute anzeigen

data.latency.processing.p50_ms

nullable integer

erforderlich

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

data.latency.processing.p95_ms

nullable integer

erforderlich

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

data.latency.processing.p99_ms

nullable integer

erforderlich

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 over the bucket. All three are null when no qualifying event contributed a measurement.

Untergeordnete Attribute anzeigen

data.latency.total

object

Approximate p50, p95, and p99 latency percentiles in milliseconds for one latency family over the bucket. All three are null when no qualifying event contributed a measurement.

Untergeordnete Attribute anzeigen

data.trend

array of object

A short series of this template's delivery and engagement rates, one point per time bucket over the window. Only present when you set include_trend=true on the request.

Untergeordnete Attribute anzeigen

total

integer

erforderlich

Total number of distinct templates with activity in the period, regardless of limit. Pass next_cursor as starting_after to request the next page.

next_cursor

nullable string

erforderlich

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor

nullable string

erforderlich

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor

nullable string

erforderlich

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten

const { data } = await bird.email.stats.byTemplate({
  from: "2026-05-01",
  to: "2026-05-31",
  sort: "open_rate",
  limit: 25,
});
for (const row of data) console.log(row.template_id, row.engagement.open_rate);

stats = client.email.stats.by_template(from_="2026-05-01", to="2026-05-25")
for row in stats.data:
    print(row)

stats, err := client.Email.Stats.ByTemplate(context.Background(), bird.EmailStatsByTemplateParams{})
if err != nil {
	log.Fatal(err)
}
fmt.Println(stats.Data)

$stats = $bird->email->stats->byTemplate([
    'from' => '2026-05-01',
    'to' => '2026-05-31',
    'sort' => 'open_rate',
    'limit' => 25,
]);
foreach ($stats->getData() ?? [] as $row) {
    echo $row->getTemplateId(), ' ', $row->getEngagement()?->getOpenRate(), "\n";
}

bird email stats by-template

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

Antwort200

{
  "period": {
    "from": "2026-05-01",
    "to": "2026-05-25",
    "data_as_of": "2026-05-25T14:03:10Z"
  },
  "data": [
    {
      "template_id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
      "delivery": {
        "accepted": 14820,
        "processed": 14810,
        "delivered": 14720,
        "bounced": 90,
        "bounces": {
          "hard": 12410,
          "soft": 14290,
          "admin": 410,
          "block": 920,
          "undetermined": 80,
          "hard_rate": 0.454,
          "soft_rate": 0.523,
          "admin_rate": 0.015,
          "block_rate": 0.0337,
          "undetermined_rate": 0.0029
        },
        "complained": 3,
        "deferred": 14,
        "rejected": 10,
        "oob_bounces": 2,
        "effective_delivered": 14718,
        "all_bounces": 92,
        "oob_rate": 0.00014,
        "delivery_rate": 0.9939,
        "bounce_rate": 0.0061,
        "complaint_rate": 0.0002
      },
      "engagement": {
        "opens": 5420,
        "opens_non_prefetched": 3210,
        "unique_opens": 3640,
        "unique_opens_non_prefetched": 2480,
        "clicks": 924,
        "unique_clicks": 621,
        "unsubscribes": 12,
        "open_rate": 0.1683,
        "click_rate": 0.0422,
        "unsubscribe_rate": 0.0009
      },
      "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-12"
        }
      ]
    }
  ],
  "total": 42,
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Get statistics by template

Abfrageparameter

Antwort-Payload

Verwandte Ressourcen