Statistiques
Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.
Opérations
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.
Paramètres de requête
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.
Au moins -840Au plus 840Par défaut0grainstringHow wide one bucket of
daysandseriesis.L'un de"minute""hour""day"Par défaut"day"addressstringCount only the mail delivered to this address. One the key does not reach counts nothing.
De 3 à 320 caractères
Retourne
The numbers for the window.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de requête
daysintegerWindow length in days.
Au moins 1Au plus 365Par défaut30minutesintegerWindow length in minutes, which wins over
days.Au moins 1Au plus 525600grainstringHow wide one bucket of
daysis.L'un de"minute""hour""day"Par défaut"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, from -840 to 840.
Au moins -840Au plus 840Par défaut0addressstringCount only the mail sent from this address. One the key does not reach counts nothing.
De 3 à 320 caractères
Retourne
The numbers for the window.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
Objets
MailboxInsightsobject
objectstringObligatoire- L'un de
"mailbox_insights" fromstringObligatoire- Format
date-time tostringObligatoire- Format
date-time grainstringObligatoire- L'un de
"minute""hour""day"Par défaut"day" offsetMinutesintegerObligatoirescannedintegerObligatoireConversations that arrived inside the window.
daysobject[]ObligatoiredaystringObligatoireThe bucket:
YYYY-MM-DD,YYYY-MM-DDTHHorYYYY-MM-DDTHH:MMbygrain.countintegerObligatoire
hoursobject[]ObligatoirehourintegerObligatoireThe hour of the day, 0 to 23, in
offsetMinutes.countintegerObligatoire
addressesobject[]ObligatoireaddressstringObligatoireThe address the mail arrived at.
countintegerObligatoire
sendersobject[]ObligatoireThe senders who wrote most, most first.
emailstringnamestring- Peut être null
countintegerlastAtstring- Format
date-time
senderCountintegerObligatoireEveryone who wrote inside the window.
waitingobject[]ObligatoireConversations whose last message came from somebody else, by how many days it has waited.
bandintegerObligatoireAt least this many days.
countintegerObligatoire
unattributedintegerObligatoireMail that recorded no address it arrived at.
foldersobject[]Obligatoirelabelstringcountintegerunreadinteger
seriesobject[]ObligatoirePer bucket counts for the top addresses and senders, so each can be charted.
kindstringkeystringdaystringcountinteger
SendingAnalyticsobject
objectstringObligatoire- L'un de
"sending_analytics" sincestringObligatoire- Format
date-time untilstringObligatoire- Format
date-time grainstringObligatoire- L'un de
"minute""hour""day"Par défaut"day" offsetMinutesintegerObligatoiretotalsobjectObligatoiresendsintegertestSendsintegerrecipientsintegerdeliveredintegerfailedintegerbouncedintegercomplainedintegeruncertainintegerpendinginteger
daysobject[]Obligatoiredaystringsentintegerdeliveredintegerfailedintegerbouncedintegercomplainedinteger
statusesobject[]ObligatoireSends by status.
labelstringObligatoireWhat is counted.
countintegerObligatoire
sourcesobject[]ObligatoireSends by where they came from: the app, the API, a broadcast and the rest.
labelstringObligatoireWhat is counted.
countintegerObligatoire
sendersobject[]ObligatoireSends by the address they went out as.
labelstringObligatoireWhat is counted.
countintegerObligatoire
suppressedobject[]ObligatoireAddresses that were suppressed, by reason.
labelstringObligatoireWhat is counted.
countintegerObligatoire