Get transactional tag metrics

GET

/api/v3/transactionals/tags/metrics

const url = 'https://api.tryletterhead.com/api/v3/transactionals/tags/metrics?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/transactionals/tags/metrics?api=true' \
  --header 'Authorization: Bearer <token>'

Per-tag rolled-up engagement metrics for your company’s transactional emails over a window — sends, open/click/bounce/spam rates, and when each tag was last sent. Rates are derived from the summed counts across every send carrying the tag, not averaged per send.

Authorization: Bearer token (company-level API key). The caller must be a company administrator.

Availability: Requires your tenant to be opted into transactional email (the same deployment setting actions/send and actions/draft need) — but, unlike those, does not require companyAudienceSending, since reading already-recorded metrics doesn’t depend on the sending pipeline.

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true to authenticate with an API key.

channels[]

string

Channel slug to restrict the rollup to. Repeat the parameter once per channel. Omit for every channel.

from

string format: date

Start of the window (inclusive). Defaults to 90 days before to.

string format: date

End of the window (inclusive). Defaults to now. The window cannot exceed 90 days.

Responses

200

200 OK

application/json

object

items

Array<object>

object

uniqueId

string

tag

string

sends

integer

openRate

number

clickRate

number

bounceRate

number

spamRate

number

lastSentAt

string

message

string

total

integer

Example

{
  "items": [
    {
      "uniqueId": "password-reset",
      "tag": "password-reset",
      "sends": 42,
      "openRate": 0.71,
      "clickRate": 0.38,
      "bounceRate": 0.02,
      "spamRate": 0,
      "lastSentAt": "2026-08-30 14:02:11"
    }
  ],
  "message": "Transactional tag metrics.",
  "total": 1
}

Still can’t find what you need? Contact support.