Retrieve Metrics

Contact counts for your account, optionally broken down by segment. Works across your whole account by default, or scoped to specific segments via segment_id.

All parameters are optional. With none, the response covers your whole account, includes every metric, and returns only totals. There's no date range, so counts are a point-in-time snapshot rather than a historical window.

List-type query parameters below accept a comma-separated value, the parameter repeated (segment_id=a&segment_id=b), or a mix of both.

List of metrics to include in totals and data. Omit for all. See Metrics.

List of dimensions to break data down by. Omit for only totals, with no data.

Possible values:

• segment: one row per segment, using its current contact counts.

List of segment IDs. Narrows totals (and data, when requested) to just these segments, without double-counting contacts that belong to more than one.

Every metric counts contacts, not emails.

import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.segments.metrics({
  dimensions: ['segment'],
  metrics: ['all_contacts'],
});

curl -X GET 'https://api.resend.com/segments/metrics?dimensions=segment&metrics=all_contacts' \
     -H 'Authorization: Bearer re_xxxxxxxxx'

{
  "object": "metrics",
  "metrics": ["all_contacts"],
  "dimensions": ["segment"],
  "totals": {
    "all_contacts": 12450
  },
  "data": [
    {
      "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
      "name": "Registered Users",
      "all_contacts": 4300
    }
  ]
}