Análises
Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.
Operações
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.
Parâmetros de consulta
fromstringThe start of the window, ISO 8601 with a zone. Defaults to 30 days before
to.Formatodate-timetostringThe end of the window. Defaults to now.
Formatodate-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.
Pelo menos -840No máximo 840Predefinição0grainstringHow wide one bucket of
daysandseriesis.Um de"minute""hour""day"Predefinição"day"addressstringCount only the mail delivered to this address. One the key does not reach counts nothing.
De 3 a 320 caracteres
Devolve
The numbers for the window.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de consulta
daysintegerWindow length in days.
Pelo menos 1No máximo 365Predefinição30minutesintegerWindow length in minutes, which wins over
days.Pelo menos 1No máximo 525600grainstringHow wide one bucket of
daysis.Um de"minute""hour""day"Predefinição"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, from -840 to 840.
Pelo menos -840No máximo 840Predefinição0addressstringCount only the mail sent from this address. One the key does not reach counts nothing.
De 3 a 320 caracteres
Devolve
The numbers for the window.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
Objetos
MailboxInsightsobject
objectstringObrigatório- Um de
"mailbox_insights" fromstringObrigatório- Formato
date-time tostringObrigatório- Formato
date-time grainstringObrigatório- Um de
"minute""hour""day"Predefinição"day" offsetMinutesintegerObrigatórioscannedintegerObrigatórioConversations that arrived inside the window.
daysobject[]ObrigatóriodaystringObrigatórioThe bucket:
YYYY-MM-DD,YYYY-MM-DDTHHorYYYY-MM-DDTHH:MMbygrain.countintegerObrigatório
hoursobject[]ObrigatóriohourintegerObrigatórioThe hour of the day, 0 to 23, in
offsetMinutes.countintegerObrigatório
addressesobject[]ObrigatórioaddressstringObrigatórioThe address the mail arrived at.
countintegerObrigatório
sendersobject[]ObrigatórioThe senders who wrote most, most first.
emailstringnamestring- Pode ser null
countintegerlastAtstring- Formato
date-time
senderCountintegerObrigatórioEveryone who wrote inside the window.
waitingobject[]ObrigatórioConversations whose last message came from somebody else, by how many days it has waited.
bandintegerObrigatórioAt least this many days.
countintegerObrigatório
unattributedintegerObrigatórioMail that recorded no address it arrived at.
foldersobject[]Obrigatóriolabelstringcountintegerunreadinteger
seriesobject[]ObrigatórioPer bucket counts for the top addresses and senders, so each can be charted.
kindstringkeystringdaystringcountinteger
SendingAnalyticsobject
objectstringObrigatório- Um de
"sending_analytics" sincestringObrigatório- Formato
date-time untilstringObrigatório- Formato
date-time grainstringObrigatório- Um de
"minute""hour""day"Predefinição"day" offsetMinutesintegerObrigatóriototalsobjectObrigatóriosendsintegertestSendsintegerrecipientsintegerdeliveredintegerfailedintegerbouncedintegercomplainedintegeruncertainintegerpendinginteger
daysobject[]Obrigatóriodaystringsentintegerdeliveredintegerfailedintegerbouncedintegercomplainedinteger
statusesobject[]ObrigatórioSends by status.
labelstringObrigatórioWhat is counted.
countintegerObrigatório
sourcesobject[]ObrigatórioSends by where they came from: the app, the API, a broadcast and the rest.
labelstringObrigatórioWhat is counted.
countintegerObrigatório
sendersobject[]ObrigatórioSends by the address they went out as.
labelstringObrigatórioWhat is counted.
countintegerObrigatório
suppressedobject[]ObrigatórioAddresses that were suppressed, by reason.
labelstringObrigatórioWhat is counted.
countintegerObrigatório