Skip to Content

The AccountEvents type of the TypeScript SDK, which accounts.listEvents take or answer.

type AccountEvents = {
  accountId: string
  domains: string[]
  domainsTruncated: boolean
  estimated: boolean
  events: AccountTrafficEvent[]
  nextCursor?: string
  range: string
}

Fields

FieldTypeDescription
accountIdstringAccount ID
domainsstring[]Domain names the query was scoped to
domainsTruncatedbooleanTrue if the account owns more domains than the query limit
estimatedbooleanTrue if numbers are estimated (false for authoritative logs)
eventsAccountTrafficEvent[]List of authoritative traffic events across the account's domains
nextCursorstringOptional. Pagination cursor for next page of events
rangestringTime range queried (e.g. '24h', '7d')

Used by

MethodWhat it does
accounts.listEventsQuery account delivery event log

On this page