Class MailAnalyticsClient

Tenant mail-analytics operations.

All intervals are start-inclusive and end-exclusive, must use UTC, and must align to hour or day boundaries.

Index

Constructors

Methods

activityHeatmap breakdown comparison domainLifecycle lifecycle listenerOverview overview series taskSizeStatistics

Constructors

constructor

new MailAnalyticsClient(
options: MailAnalyticsClientOptions,
): MailAnalyticsClient
Parameters
- options: MailAnalyticsClientOptions
  The underlying admin client and tenant slug.
Returns MailAnalyticsClient
- Defined in mail-analytics/client.ts:181

Methods

activityHeatmap

activityHeatmap(options: IntervalOptions): Promise<MailAnalyticsActivityHeatmap>
Fetches the activity heatmap.
Parameters
- options: IntervalOptions
  The interval and cancellation signal.
Returns Promise<MailAnalyticsActivityHeatmap>
The heatmap.
- Defined in mail-analytics/client.ts:234

breakdown

breakdown(options: BreakdownOptions): Promise<MailAnalyticsBreakdown>
Fetches a metric breakdown.
Parameters
- options: BreakdownOptions
  The interval, metric, dimension, optional limit, and signal.
Returns Promise<MailAnalyticsBreakdown>
The breakdown.
- Defined in mail-analytics/client.ts:316

comparison

comparison(options: IntervalOptions): Promise<MailAnalyticsComparison>
Fetches the comparison report.
Parameters
- options: IntervalOptions
  The interval and cancellation signal.
Returns Promise<MailAnalyticsComparison>
The comparison.
- Defined in mail-analytics/client.ts:214

domainLifecycle

domainLifecycle(
options: DomainLifecycleOptions,
): Promise<MailAnalyticsDomainLifecycle>
Fetches the domain-lifecycle report.
Parameters
- options: DomainLifecycleOptions
  The cohort, observation end, optional filters, and signal.
Returns Promise<MailAnalyticsDomainLifecycle>
The domain-lifecycle report.
- Defined in mail-analytics/client.ts:364

lifecycle

lifecycle(options: LifecycleOptions): Promise<MailAnalyticsLifecycle>
Fetches the lifecycle report.
Parameters
- options: LifecycleOptions
  The cohort, observation end, and cancellation signal.
Returns Promise<MailAnalyticsLifecycle>
The lifecycle report.
- Defined in mail-analytics/client.ts:295

listenerOverview

listenerOverview(
options: ListenerOverviewOptions,
): Promise<MailAnalyticsListenerOverview>
Fetches one listener's mail-analytics overview.
Parameters
- options: ListenerOverviewOptions
  The interval, listener id, and cancellation signal.
Returns Promise<MailAnalyticsListenerOverview>
The listener overview.
- Defined in mail-analytics/client.ts:274

overview

overview(options: IntervalOptions): Promise<MailAnalyticsOverview>
Fetches the overview report.
Parameters
- options: IntervalOptions
  The interval and cancellation signal.
Returns Promise<MailAnalyticsOverview>
The overview.
- Defined in mail-analytics/client.ts:194

series

series(options: BreakdownOptions): Promise<MailAnalyticsSeries>
Fetches a metric series.
Parameters
- options: BreakdownOptions
  The interval, metric, dimension, optional limit, and signal.
Returns Promise<MailAnalyticsSeries>
The series.
- Defined in mail-analytics/client.ts:340

taskSizeStatistics

taskSizeStatistics(
options: IntervalOptions,
): Promise<MailAnalyticsTaskSizeStatistics>
Fetches task-size statistics.
Parameters
- options: IntervalOptions
  The interval and cancellation signal.
Returns Promise<MailAnalyticsTaskSizeStatistics>
The task-size statistics.
- Defined in mail-analytics/client.ts:254