Skip to Content

The UsageDay type of the TypeScript SDK, part of AccountUsage.

type UsageDay = {
  calendarObjects: number | null
  closedAt: number | null
  contactObjects: number | null
  day: string
  estimated: boolean
  eventsPushedImap: number | null
  eventsPushedJmap: number | null
  eventsPushedWeb: number | null
  forwardedMessages: number | null
  inboundBytes: number | null
  inboundDeliveries: number | null
  mailBytes: number | null
  mailboxes: number | null
  maxDatabaseSize: number | null
  outboundBytes: number | null
  outboundMessages: number | null
  outboundRecipients: number | null
  pimBytes: number | null
  pimRelayedImap: number | null
  pimRelayedJmap: number | null
  pimRelayedWeb: number | null
  reportedAt: number | null
  requestBytesOut: number | null
  requests: number | null
  requestsRolledAt: number | null
  rolledAt: number | null
  socketsAcceptedImap: number | null
  socketsAcceptedJmap: number | null
  socketsAcceptedWeb: number | null
  trashBytes: number | null
  webhookDeliveries: number | null
}

Fields

FieldTypeDescription
calendarObjectsnumber | nullTotal calendar events and tasks stored, or null
closedAtnumber | nullTimestamp when the day's metrics were finalized and closed in epoch seconds, or null
contactObjectsnumber | nullTotal address book contacts stored, or null
daystringUTC date string in YYYY-MM-DD format
estimatedbooleanTrue if storage numbers are estimated or carried forward
eventsPushedImapnumber | nullCumulative live events pushed to IMAP IDLE clients, or null
eventsPushedJmapnumber | nullCumulative live events pushed to JMAP SSE clients, or null
eventsPushedWebnumber | nullCumulative live events pushed to web clients, or null
forwardedMessagesnumber | nullCount of auto-forwarded or redirected messages, or null
inboundBytesnumber | nullTotal size of inbound mail in bytes, or null
inboundDeliveriesnumber | nullCount of messages delivered into account mailboxes, or null
mailBytesnumber | nullTotal mail storage in bytes at day close (including trash), or null
mailboxesnumber | nullNumber of active mailboxes/identities on the account, or null
maxDatabaseSizenumber | nullThe account's LARGEST single store's metadata database size in bytes that day (MAX across mailboxes, not a sum — the figure that measures distance to the per-store store_metadata_full ceiling), or null when not measured
outboundBytesnumber | nullTotal size of outbound mail relayed in bytes, or null
outboundMessagesnumber | nullCount of distinct outbound messages sent, or null
outboundRecipientsnumber | nullTotal outbound recipient deliveries relayed, or null
pimBytesnumber | nullCalendar and contacts storage in bytes, or null
pimRelayedImapnumber | nullRetired: the mail store no longer relays pim.changed, so this is null for every day filed since. Earlier days keep the cumulative frames it relayed to imap-class sockets
pimRelayedJmapnumber | nullRetired: the mail store no longer relays pim.changed, so this is null for every day filed since. Earlier days keep the cumulative frames it relayed to jmap-class sockets
pimRelayedWebnumber | nullRetired: the mail store no longer relays pim.changed, so this is null for every day filed since. Earlier days keep the cumulative frames it relayed to web-class sockets
reportedAtnumber | nullTimestamp when usage was reported to billing system in epoch seconds, or null
requestBytesOutnumber | nullTotal API response bandwidth consumed in bytes, or null
requestsnumber | nullTotal API requests made to this account, or null
requestsRolledAtnumber | nullTimestamp when API request metrics were aggregated in epoch seconds, or null
rolledAtnumber | nullTimestamp when daily usage was aggregated in epoch seconds, or null
socketsAcceptedImapnumber | nullCumulative websocket/IDLE connections opened by IMAP clients, or null
socketsAcceptedJmapnumber | nullCumulative event connections opened by JMAP clients, or null
socketsAcceptedWebnumber | nullCumulative websocket connections opened by web clients, or null
trashBytesnumber | nullStorage bytes occupied by trash messages, or null
webhookDeliveriesnumber | nullCount of outgoing webhook notifications, or null

Used in

AccountUsage.

On this page