📊 Metrics module Email API

This module allows you to retrieve metrics for messages sent from your account.

Methods

• Engagement
• Performance
• Recipient Behaviour
• Volume
• Usage
• Senders

Type declarations

class Metrics {
  constructor (protected mailchannels: MailChannelsClient);
  async engagement (options?: MetricsOptions): Promise<MetricsEngagementResponse>;
  async performance (options?: MetricsOptions): Promise<MetricsPerformanceResponse>;
  async recipientBehaviour (options?: MetricsOptions): Promise<MetricsRecipientBehaviourResponse>;
  async volume (options?: MetricsOptions): Promise<MetricsVolumeResponse>;
  async usage (): Promise<MetricsUsageResponse>;
  async senders (type: MetricsSendersType, options?: MetricsSendersOptions): Promise<MetricsSendersResponse>;
}

All type declarations

Response type declarations

interface ErrorResponse {
  message: string;
  statusCode: number | null;
  type: ErrorType;
}

type DataResponse<T> = {
  data: T;
  error: null;
} | {
  data: null;
  error: ErrorResponse;
};

Shared metrics type declarations

interface MetricsOptions {
  startTime?: string;
  endTime?: string;
  campaignId?: string;
  interval?: "hour" | "day" | "week" | "month";
}

interface MetricsBucket {
  count: number;
  periodStart: string;
}

Engagement type declarations

interface MetricsEngagement {
  buckets: {
    click: MetricsBucket[];
    clickTrackingDelivered: MetricsBucket[];
    open: MetricsBucket[];
    openTrackingDelivered: MetricsBucket[];
  };
  click: number;
  clickTrackingDelivered: number;
  endTime: string;
  open: number;
  openTrackingDelivered: number;
  startTime: string;
}

type MetricsEngagementResponse = DataResponse<MetricsEngagement>;

Performance type declarations

interface MetricsPerformance {
  bounced: number;
  buckets: {
    bounced: MetricsBucket[];
    delivered: MetricsBucket[];
    processed: MetricsBucket[];
  };
  delivered: number;
  endTime: string;
  processed: number;
  startTime: string;
}

type MetricsPerformanceResponse = DataResponse<MetricsPerformance>;

Recipient Behaviour type declarations

interface MetricsRecipientBehaviour {
  buckets: {
    unsubscribeDelivered: MetricsBucket[];
    unsubscribed: MetricsBucket[];
  };
  endTime: string;
  startTime: string;
  unsubscribeDelivered: number;
  unsubscribed: number;
}

type MetricsRecipientBehaviourResponse = DataResponse<MetricsRecipientBehaviour>;

Volume type declarations

interface MetricsVolume {
  buckets: {
    delivered: MetricsBucket[];
    dropped: MetricsBucket[];
    processed: MetricsBucket[];
  };
  delivered: number;
  dropped: number;
  endTime: string;
  processed: number;
  startTime: string;
}

type MetricsVolumeResponse = DataResponse<MetricsVolume>;

Usage type declarations

type MetricsUsageResponse = DataResponse<{
  endDate?: string;
  startDate?: string;
  total: number;
}>;

Senders type declarations

type MetricsSendersType = "sub-accounts" | "campaigns";

interface MetricsSendersOptions {
  startTime?: string;
  endTime?: string;
  limit?: number;
  offset?: number;
  sortOrder?: "asc" | "desc";
}

interface MetricsSenders {
  endTime: string;
  limit: number;
  offset: number;
  senders: {
    bounced: number;
    delivered: number;
    dropped: number;
    name: string;
    processed: number;
  }[];
  startTime: string;
  total: number;
}

type MetricsSendersResponse = DataResponse<MetricsSenders>;

Source

Source • Playground • Docs • Tests

Changelog

• v0.8.0 on May 23, 2026
  • ab66dc1 — refactor: split internal utils into focused modules