Skip to Content

The AccountTraffic type of the TypeScript SDK, which accounts.getTraffic take or answer.

type AccountTraffic = {
  accountId: string
  byOutcome: Record<string, number>
  domains: string[]
  domainsTruncated: boolean
  estimated: boolean
  mailboxId?: string
  range: string
  retentionDays: number
  rows: TrafficRow[]
  series?: TrafficSeriesPoint[]
  totals: AccountTrafficTotals
}

Fields

FieldTypeDescription
accountIdstringAccount ID
byOutcomeRecord<string, number>Breakdown of event counts by outcome
domainsstring[]List of domain names included in this aggregate
domainsTruncatedbooleanTrue if account owns more domains than query limit
estimatedbooleanTrue if metrics are sampled estimates
mailboxIdstringOptional. Present when the aggregate was narrowed to one mailbox
rangestringTime range of statistics
retentionDaysnumberAnalytics retention window in days
rowsTrafficRow[]Breakdown rows grouped by outcome and route kind
seriesTrafficSeriesPoint[]Optional. Time-series buckets for charting
totalsAccountTrafficTotals

Used by

MethodWhat it does
accounts.getTrafficGet account traffic statistics

On this page