Skip to Content

The TrafficSeriesPoint type of the TypeScript SDK, part of AccountTraffic and 1 more types.

type TrafficSeriesPoint = {
  bucket: string
  byOutcome?: Record<string, number>
  bytes: number
  bytesIn: number
  bytesOut: number
  events: number
  forwarded: number
  inbound: number
  outbound: number
}

Fields

FieldTypeDescription
bucketstringTime bucket start timestamp ISO string
byOutcomeRecord<string, number>Optional. Breakdown of event counts keyed by outcome
bytesnumberTotal traffic bytes in this time bucket
bytesInnumberBytes received in this time bucket, by the rule daily usage counts inboundBytes by: each copy that reached a hosted address (stored, or filtered by its rules) and each admission to a webhook or forward route. A subset of bytes, sampled like it, and not deduped by delivery as the daily ledger is
bytesOutnumberBytes sent in this time bucket, by the rule daily usage counts outboundBytes by: each recipient leg of a send, hosted or external, counted when the send was accepted (on the relay's success, for days before usage counted at acceptance). A forward's bytes are in neither this nor bytesIn, so this is not the bytes of outbound
eventsnumberTotal traffic events in this time bucket
forwardednumberThe inbound-driven SUBSET of outbound (never a third direction): mail that left because a route was configured rather than because anyone submitted it. Bounded by the per-domain forwarding budget, billed on its own axis (forwardedMessages), and spends no send allowance
inboundnumberMessages received in this time bucket, one per copy, by the rule daily usage counts inboundDeliveries by: each copy that reached a hosted address (from outside, as a group member, or from a hosted sender), was filtered by its rules, or was admitted to a webhook or forward route. Deferrals, refusals, duplicates, uploads, imports and Sent copies are not counted. Sampled, and not deduped by delivery as the daily ledger is
outboundnumberRecipient legs sent in this time bucket, one per recipient, by the rule daily usage counts outboundRecipients by (counted when the send was accepted, or on the relay's success for days before usage counted at acceptance), plus each target a forward reached (forwarded). Deferrals and retries are not counted again. Sampled, and not deduped by delivery as the daily ledger is

Used in

AccountTraffic, DomainTraffic.

On this page