Retrieve Metrics

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
    }
  ]
}

GET

segments

metrics

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
    }
  ]
}

Segment metrics are currently in private beta and only available to a limited number of users. The response shape might change before GA. Get in touch if you’re interested in testing this feature.Once you have access, upgrade your Resend SDK to use the methods on this page:

npm install resend@6.19.0-preview-headless-dashboard.7

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.

Responses are cached for up to 15 minutes, so repeating the same request may return slightly stale data within that window.

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.

Query Parameters

When dimensions includes segment, data is ordered by each segment’s creation date, newest first.

Metrics

Every metric counts contacts, not emails.

Metric	Description
`all_contacts`	Every contact. Sum of `subscribers` and `unsubscribers`.
`subscribers`	Contacts with `unsubscribed` set to `false`.
`unsubscribers`	Contacts with `unsubscribed` set to `true`.

totals counts each contact once. data counts a contact in every segment it belongs to.

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
    }
  ]
}

⌘I

API Reference

Sending

Receiving

Broadcasts

Automations

Events

Templates

Contacts

Contact Properties

Contact Imports

Segments

Topics

Audiences

Domains

Logs

Usage

API Keys

Suppressions

Authorized Apps

Webhooks

OAuth

Retrieve Metrics

Query Parameters

Metrics

​Query Parameters

​Metrics

Query Parameters

Metrics