Analizler
Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.
İşlemler
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.
Sorgu parametreleri
fromstringThe start of the window, ISO 8601 with a zone. Defaults to 30 days before
to.Biçimdate-timetostringThe end of the window. Defaults to now.
Biçimdate-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.
En az -840En çok 840Varsayılan0grainstringHow wide one bucket of
daysandseriesis.Şunlardan biri"minute""hour""day"Varsayılan"day"addressstringCount only the mail delivered to this address. One the key does not reach counts nothing.
3 ile 320 karakter arası
Döndürür
The numbers for the window.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Sorgu parametreleri
daysintegerWindow length in days.
En az 1En çok 365Varsayılan30minutesintegerWindow length in minutes, which wins over
days.En az 1En çok 525600grainstringHow wide one bucket of
daysis.Şunlardan biri"minute""hour""day"Varsayılan"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, from -840 to 840.
En az -840En çok 840Varsayılan0addressstringCount only the mail sent from this address. One the key does not reach counts nothing.
3 ile 320 karakter arası
Döndürür
The numbers for the window.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
Nesneler
MailboxInsightsobject
objectstringZorunlu- Şunlardan biri
"mailbox_insights" fromstringZorunlu- Biçim
date-time tostringZorunlu- Biçim
date-time grainstringZorunlu- Şunlardan biri
"minute""hour""day"Varsayılan"day" offsetMinutesintegerZorunluscannedintegerZorunluConversations that arrived inside the window.
daysobject[]ZorunludaystringZorunluThe bucket:
YYYY-MM-DD,YYYY-MM-DDTHHorYYYY-MM-DDTHH:MMbygrain.countintegerZorunlu
hoursobject[]ZorunluhourintegerZorunluThe hour of the day, 0 to 23, in
offsetMinutes.countintegerZorunlu
addressesobject[]ZorunluaddressstringZorunluThe address the mail arrived at.
countintegerZorunlu
sendersobject[]ZorunluThe senders who wrote most, most first.
emailstringnamestring- null olabilir
countintegerlastAtstring- Biçim
date-time
senderCountintegerZorunluEveryone who wrote inside the window.
waitingobject[]ZorunluConversations whose last message came from somebody else, by how many days it has waited.
bandintegerZorunluAt least this many days.
countintegerZorunlu
unattributedintegerZorunluMail that recorded no address it arrived at.
foldersobject[]Zorunlulabelstringcountintegerunreadinteger
seriesobject[]ZorunluPer bucket counts for the top addresses and senders, so each can be charted.
kindstringkeystringdaystringcountinteger
SendingAnalyticsobject
objectstringZorunlu- Şunlardan biri
"sending_analytics" sincestringZorunlu- Biçim
date-time untilstringZorunlu- Biçim
date-time grainstringZorunlu- Şunlardan biri
"minute""hour""day"Varsayılan"day" offsetMinutesintegerZorunlutotalsobjectZorunlusendsintegertestSendsintegerrecipientsintegerdeliveredintegerfailedintegerbouncedintegercomplainedintegeruncertainintegerpendinginteger
daysobject[]Zorunludaystringsentintegerdeliveredintegerfailedintegerbouncedintegercomplainedinteger
statusesobject[]ZorunluSends by status.
labelstringZorunluWhat is counted.
countintegerZorunlu
sourcesobject[]ZorunluSends by where they came from: the app, the API, a broadcast and the rest.
labelstringZorunluWhat is counted.
countintegerZorunlu
sendersobject[]ZorunluSends by the address they went out as.
labelstringZorunluWhat is counted.
countintegerZorunlu
suppressedobject[]ZorunluAddresses that were suppressed, by reason.
labelstringZorunluWhat is counted.
countintegerZorunlu