Interface BreakdownOptions

Options for breakdown and series operations.

interface BreakdownOptions {
    dimension: MailAnalyticsDimension;
    endAt: string;
    limit?: number;
    metric: MailAnalyticsMetric;
    signal?: AbortSignal;
    startAt: string;
}

Hierarchy (View Summary)

IntervalOptions
- BreakdownOptions

Index

Properties

dimension endAt limit? metric signal? startAt

Properties

`Readonly`dimension

dimension: MailAnalyticsDimension

The dimension to group by.

`Readonly`endAt

endAt: string

Interval end, an exclusive UTC ISO-8601 timestamp.

`Optional` `Readonly`limit

limit?: number

An optional limit between 1 and 20.

`Readonly`metric

metric: MailAnalyticsMetric

The metric to report.

`Optional` `Readonly`signal

signal?: AbortSignal

Cancels the request and any in-flight rate-limit backoff.

`Readonly`startAt

startAt: string

Interval start, an inclusive UTC ISO-8601 timestamp.