Analytics
Every operation in this group: what it accepts, what it returns and the errors it can answer with.
Operations
The numbers behind the Analytics page of the app: how mail arrives in the mailbox, and what became of the mail the workspace sent.
GET/analytics/mailbox
Read how mail arrives
How mail arrives, as the Analytics page of the app shows it, for a window of 30 days up to now unless from and to say otherwise: conversations per day or per grain bucket and per hour of the day, the addresses they arrived at, the senders who wrote most, how many wait on a reply for 1, 3, 7 days or more, and the folders. A key or an app limited to particular addresses counts only the mail that arrived at them, and address narrows everything to one address.
Requires the threads:read scope.
Query parameters
fromstringThe start of the window, ISO 8601 with a zone. Defaults to 30 days before
to.Formatdate-timetostringThe end of the window. Defaults to now.
Formatdate-timeoffsetMinutesintegerMinutes east of UTC to cut days and hours in, from -840 to 840. Pass the reader’s offset so a day breaks where theirs does.
At least -840At most 840Default0grainstringHow wide one bucket of
daysandseriesis.One of"minute""hour""day"Default"day"addressstringCount only the mail delivered to this address. One the key does not reach counts nothing.
3 to 320 characters
Returns
The numbers for the window.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
GET/analytics/sending
Read what became of sent mail
What the workspace sent inside a window and what became of it, as the Analytics page of the app shows it: delivered, failed, bounced and complained, per day or per grain bucket, with the statuses, the sources, the senders and the addresses suppressed. The window is days, 30 by default and at most 365, or minutes, which wins, and it starts at the beginning of its oldest bucket. A key or an app limited to particular addresses counts only the mail sent from them.
Requires the emails:read scope.
Query parameters
daysintegerWindow length in days.
At least 1At most 365Default30minutesintegerWindow length in minutes, which wins over
days.At least 1At most 525600grainstringHow wide one bucket of
daysis.One of"minute""hour""day"Default"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, from -840 to 840.
At least -840At most 840Default0addressstringCount only the mail sent from this address. One the key does not reach counts nothing.
3 to 320 characters
Returns
The numbers for the window.
Errors
The errors every operation can return400401403404422500Error catalog
Also available in
Objects
MailboxInsightsobject
objectstringRequired- One of
"mailbox_insights" fromstringRequired- Format
date-time tostringRequired- Format
date-time grainstringRequired- One of
"minute""hour""day"Default"day" offsetMinutesintegerRequiredscannedintegerRequiredConversations that arrived inside the window.
daysobject[]RequireddaystringRequiredThe bucket:
YYYY-MM-DD,YYYY-MM-DDTHHorYYYY-MM-DDTHH:MMbygrain.countintegerRequired
hoursobject[]RequiredhourintegerRequiredThe hour of the day, 0 to 23, in
offsetMinutes.countintegerRequired
addressesobject[]RequiredaddressstringRequiredThe address the mail arrived at.
countintegerRequired
sendersobject[]RequiredThe senders who wrote most, most first.
emailstringnamestring- Can be null
countintegerlastAtstring- Format
date-time
senderCountintegerRequiredEveryone who wrote inside the window.
waitingobject[]RequiredConversations whose last message came from somebody else, by how many days it has waited.
bandintegerRequiredAt least this many days.
countintegerRequired
unattributedintegerRequiredMail that recorded no address it arrived at.
foldersobject[]Requiredlabelstringcountintegerunreadinteger
seriesobject[]RequiredPer bucket counts for the top addresses and senders, so each can be charted.
kindstringkeystringdaystringcountinteger
SendingAnalyticsobject
objectstringRequired- One of
"sending_analytics" sincestringRequired- Format
date-time untilstringRequired- Format
date-time grainstringRequired- One of
"minute""hour""day"Default"day" offsetMinutesintegerRequiredtotalsobjectRequiredsendsintegertestSendsintegerrecipientsintegerdeliveredintegerfailedintegerbouncedintegercomplainedintegeruncertainintegerpendinginteger
daysobject[]Requireddaystringsentintegerdeliveredintegerfailedintegerbouncedintegercomplainedinteger
statusesobject[]RequiredSends by status.
labelstringRequiredWhat is counted.
countintegerRequired
sourcesobject[]RequiredSends by where they came from: the app, the API, a broadcast and the rest.
labelstringRequiredWhat is counted.
countintegerRequired
sendersobject[]RequiredSends by the address they went out as.
labelstringRequiredWhat is counted.
countintegerRequired
suppressedobject[]RequiredAddresses that were suppressed, by reason.
labelstringRequiredWhat is counted.
countintegerRequired