import { MailChannels } from "mailchannels-sdk";

const { MAILCHANNELS_API_KEY } = process.env;
if (!MAILCHANNELS_API_KEY) throw new Error("Set MAILCHANNELS_API_KEY before running");

const mailchannels = new MailChannels(MAILCHANNELS_API_KEY);

const { data, error } = await mailchannels.metrics.recipientBehaviour({
  startTime: "2026-01-01T00:00:00Z",
  endTime: "2026-01-31T23:59:59Z",
});

if (error) {
  console.error("Get recipient behaviour metrics failed:", error);
  process.exit(1);
}
console.log(data);

import os
import sys

import mailchannels

if not os.environ.get("MAILCHANNELS_API_KEY"):
    sys.exit("Set MAILCHANNELS_API_KEY before running")

# Retrieve weekly unsubscribe activity for a single campaign.
response = mailchannels.Metrics.recipient_behaviour(
    campaign_id="weekly_newsletter",
    interval="week",
)

print(response)

<?php

require_once __DIR__ . '/vendor/autoload.php';

use MailChannels\Client;

$api_key = getenv('MAILCHANNELS_API_KEY') or exit("Error: MAILCHANNELS_API_KEY is not set\n");

$client = new Client(apiKey: $api_key);

// Retrieve weekly unsubscribe activity for a single campaign.
$response = $client->metrics->recipientBehaviour(
    campaignId: 'weekly_newsletter',
    interval:   'week',
);

print_r($response->toArray());

curl --request GET \
  --url https://api.mailchannels.net/tx/v1/metrics/recipient-behaviour \
  --header 'X-Api-Key: <x-api-key>'

{
  "buckets": {
    "unsubscribe_delivered": [
      {
        "count": 1,
        "period_start": "2023-11-07T05:31:56Z"
      }
    ],
    "unsubscribed": [
      {
        "count": 1,
        "period_start": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "unsubscribe_delivered": 1,
  "unsubscribed": 1,
  "end_time": "2023-11-07T05:31:56Z",
  "start_time": "2023-11-07T05:31:56Z"
}

{
  "errors": [
    "<string>"
  ]
}