Skip to main content

​
What recipient behavior metrics measure

Recipient behavior metrics report actions that signal recipient sentiment toward your mail. They currently cover unsubscribe activity:
  • unsubscribed: recipients who unsubscribed.
  • unsubscribe_delivered: recipients of delivered messages that include an unsubscribe link or unsubscribe header. Because the unsubscribe feature requires exactly one recipient per message, this also equals the total number of delivered messages with unsubscribe enabled.
You can use the paired values to compute an unsubscribe rate. A rising rate can indicate content fatigue, frequency issues, or an audience mismatch.

​
Example query

The example below requests weekly unsubscribe activity for a single campaign. 
#!/usr/bin/env bash
# Retrieve weekly unsubscribe activity for a single campaign.
  set -u
  : "${MAILCHANNELS_API_KEY:?Set MAILCHANNELS_API_KEY before running}"

curl -G "https://api.mailchannels.net/tx/v1/metrics/recipient-behaviour" \
  -H "X-Api-Key: $MAILCHANNELS_API_KEY" \
  --data-urlencode "campaign_id=weekly_newsletter" \
  --data-urlencode "interval=week"