Auswertungen
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
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-Parameter
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.
Mindestens -840Höchstens 840Standard0grainstringHow wide one bucket of
daysandseriesis.Einer von"minute""hour""day"Standard"day"addressstringCount only the mail delivered to this address. One the key does not reach counts nothing.
3 bis 320 Zeichen
Rückgabe
The numbers for the window.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
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-Parameter
daysintegerWindow length in days.
Mindestens 1Höchstens 365Standard30minutesintegerWindow length in minutes, which wins over
days.Mindestens 1Höchstens 525600grainstringHow wide one bucket of
daysis.Einer von"minute""hour""day"Standard"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, from -840 to 840.
Mindestens -840Höchstens 840Standard0addressstringCount only the mail sent from this address. One the key does not reach counts nothing.
3 bis 320 Zeichen
Rückgabe
The numbers for the window.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
Objekte
MailboxInsightsobject
objectstringErforderlich- Einer von
"mailbox_insights" fromstringErforderlich- Format
date-time tostringErforderlich- Format
date-time grainstringErforderlich- Einer von
"minute""hour""day"Standard"day" offsetMinutesintegerErforderlichscannedintegerErforderlichConversations that arrived inside the window.
daysobject[]ErforderlichdaystringErforderlichThe bucket:
YYYY-MM-DD,YYYY-MM-DDTHHorYYYY-MM-DDTHH:MMbygrain.countintegerErforderlich
hoursobject[]ErforderlichhourintegerErforderlichThe hour of the day, 0 to 23, in
offsetMinutes.countintegerErforderlich
addressesobject[]ErforderlichaddressstringErforderlichThe address the mail arrived at.
countintegerErforderlich
sendersobject[]ErforderlichThe senders who wrote most, most first.
emailstringnamestring- Kann null sein
countintegerlastAtstring- Format
date-time
senderCountintegerErforderlichEveryone who wrote inside the window.
waitingobject[]ErforderlichConversations whose last message came from somebody else, by how many days it has waited.
bandintegerErforderlichAt least this many days.
countintegerErforderlich
unattributedintegerErforderlichMail that recorded no address it arrived at.
foldersobject[]Erforderlichlabelstringcountintegerunreadinteger
seriesobject[]ErforderlichPer bucket counts for the top addresses and senders, so each can be charted.
kindstringkeystringdaystringcountinteger
SendingAnalyticsobject
objectstringErforderlich- Einer von
"sending_analytics" sincestringErforderlich- Format
date-time untilstringErforderlich- Format
date-time grainstringErforderlich- Einer von
"minute""hour""day"Standard"day" offsetMinutesintegerErforderlichtotalsobjectErforderlichsendsintegertestSendsintegerrecipientsintegerdeliveredintegerfailedintegerbouncedintegercomplainedintegeruncertainintegerpendinginteger
daysobject[]Erforderlichdaystringsentintegerdeliveredintegerfailedintegerbouncedintegercomplainedinteger
statusesobject[]ErforderlichSends by status.
labelstringErforderlichWhat is counted.
countintegerErforderlich
sourcesobject[]ErforderlichSends by where they came from: the app, the API, a broadcast and the rest.
labelstringErforderlichWhat is counted.
countintegerErforderlich
sendersobject[]ErforderlichSends by the address they went out as.
labelstringErforderlichWhat is counted.
countintegerErforderlich
suppressedobject[]ErforderlichAddresses that were suppressed, by reason.
labelstringErforderlichWhat is counted.
countintegerErforderlich