Skip to Content

The DomainTraffic type of the TypeScript SDK, which domains.getTraffic take or answer.

type DomainTraffic = {
  byOutcome: Record<string, number>
  domain: string
  estimated: boolean
  range: string
  retentionDays: number
  rows: TrafficRow[]
  series?: TrafficSeriesPoint[]
  totals: DomainTrafficTotals
}

Fields

FieldTypeDescription
byOutcomeRecord<string, number>Breakdown of event counts by outcome
domainstringDomain name
estimatedbooleanTrue if metrics are sampled estimates
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
totalsDomainTrafficTotals

Used by

MethodWhat it does
domains.getTrafficGet domain traffic statistics

On this page