Analytics
How mail arrives, and what became of the mail sent.
Analytics tools
| Tool | What it does |
|---|---|
| getMailboxInsights | How mail arrives over a window, as the Analytics page shows it: per day and per hour, by address and by sender, what waits on a reply, and the folders. |
| getSendingAnalytics | What became of the mail the workspace sent over a window, as the Analytics page shows it: delivered, failed, bounced and complained about, per day. |
Reading how mail arrives needs “Read threads and messages” (threads:read), and reading what became of sent mail needs “Read sent messages and their delivery status” (emails:read). A client limited to some addresses counts only the mail that arrived at them or was sent from them, and address narrows either to one address.
Reference
getMailboxInsights
How mail arrives, as the Analytics page shows it: how many conversations came in over a window and on which days, the busiest hours, the addresses they arrived at, the senders who wrote most, how many wait on a reply, and the folders. from and to are ISO 8601 instants and default to the last 30 days. offsetMinutes is the reader’s minutes east of UTC, so days break where theirs do. address narrows it to one address.
Inputs
fromstring- Format
date-time tostring- Format
date-time grainstring- One of
"minute""hour""day" offsetMinutesinteger- At least -840At most 840
addressstring- 3 to 320 characters
Also available in
getSendingAnalytics
What became of the mail this workspace sent, as the Analytics page shows it: how many went out over a window and how many were delivered, failed, bounced or complained about, per day, with the statuses, where they came from, the addresses they went out as and the addresses suppressed. days defaults to 30, minutes wins over days, and address narrows it to the mail sent from one address.
Inputs
daysinteger- At least 1At most 365
minutesinteger- At least 1At most 525600
grainstring- One of
"minute""hour""day" offsetMinutesinteger- At least -840At most 840
addressstring- 3 to 320 characters