UsageDay
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
| Field | Type | Description |
|---|---|---|
calendarObjects | number | null | Total calendar events and tasks stored, or null |
closedAt | number | null | Timestamp when the day's metrics were finalized and closed in epoch seconds, or null |
contactObjects | number | null | Total address book contacts stored, or null |
day | string | UTC date string in YYYY-MM-DD format |
estimated | boolean | True if storage numbers are estimated or carried forward |
eventsPushedImap | number | null | Cumulative live events pushed to IMAP IDLE clients, or null |
eventsPushedJmap | number | null | Cumulative live events pushed to JMAP SSE clients, or null |
eventsPushedWeb | number | null | Cumulative live events pushed to web clients, or null |
forwardedMessages | number | null | Count of auto-forwarded or redirected messages, or null |
inboundBytes | number | null | Total size of inbound mail in bytes, or null |
inboundDeliveries | number | null | Count of messages delivered into account mailboxes, or null |
mailBytes | number | null | Total mail storage in bytes at day close (including trash), or null |
mailboxes | number | null | Number of active mailboxes/identities on the account, or null |
maxDatabaseSize | number | null | The 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 |
outboundBytes | number | null | Total size of outbound mail relayed in bytes, or null |
outboundMessages | number | null | Count of distinct outbound messages sent, or null |
outboundRecipients | number | null | Total outbound recipient deliveries relayed, or null |
pimBytes | number | null | Calendar and contacts storage in bytes, or null |
pimRelayedImap | number | null | Retired: 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 |
pimRelayedJmap | number | null | Retired: 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 |
pimRelayedWeb | number | null | Retired: 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 |
reportedAt | number | null | Timestamp when usage was reported to billing system in epoch seconds, or null |
requestBytesOut | number | null | Total API response bandwidth consumed in bytes, or null |
requests | number | null | Total API requests made to this account, or null |
requestsRolledAt | number | null | Timestamp when API request metrics were aggregated in epoch seconds, or null |
rolledAt | number | null | Timestamp when daily usage was aggregated in epoch seconds, or null |
socketsAcceptedImap | number | null | Cumulative websocket/IDLE connections opened by IMAP clients, or null |
socketsAcceptedJmap | number | null | Cumulative event connections opened by JMAP clients, or null |
socketsAcceptedWeb | number | null | Cumulative websocket connections opened by web clients, or null |
trashBytes | number | null | Storage bytes occupied by trash messages, or null |
webhookDeliveries | number | null | Count of outgoing webhook notifications, or null |