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.senders("campaigns", {
  startTime: "2026-01-01T00:00:00Z",
  endTime: "2026-01-31T23:59:59Z",
});

if (error) {
  console.error("Get senders 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 the top 50 campaigns by total messages (processed + dropped) for January 2026.
response = mailchannels.Metrics.senders(
    "campaigns",
    start_time="2026-01-01T00:00:00Z",
    end_time="2026-01-31T23:59:59Z",
    limit=50,
    offset=0,
    sort_order="desc",
)

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 the top 50 campaigns by total messages (processed + dropped) for January 2026.
$response = $client->metrics->senders(
    senderType: 'campaigns',
    startTime:  '2026-01-01T00:00:00Z',
    endTime:    '2026-01-31T23:59:59Z',
    limit:      50,
    offset:     0,
    sortOrder:  'desc',
);

print_r($response->toArray());

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

{
  "limit": 123,
  "offset": 123,
  "senders": [
    {
      "bounced": 1,
      "delivered": 1,
      "dropped": 1,
      "name": "<string>",
      "processed": 1
    }
  ],
  "total": 123,
  "end_time": "2023-11-07T05:31:56Z",
  "start_time": "2023-11-07T05:31:56Z"
}