Analíticas
Cada operación de este grupo: lo que acepta, lo que devuelve y los errores con los que puede responder.
Operaciones
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.
Al menos -840Como máximo 840Predeterminado0grainstringHow wide one bucket of
daysandseriesis.Uno de"minute""hour""day"Predeterminado"day"addressstringCount only the mail delivered to this address. One the key does not reach counts nothing.
De 3 a 320 caracteres
Devuelve
The numbers for the window.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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.
Al menos 1Como máximo 365Predeterminado30minutesintegerWindow length in minutes, which wins over
days.Al menos 1Como máximo 525600grainstringHow wide one bucket of
daysis.Uno de"minute""hour""day"Predeterminado"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, from -840 to 840.
Al menos -840Como máximo 840Predeterminado0addressstringCount only the mail sent from this address. One the key does not reach counts nothing.
De 3 a 320 caracteres
Devuelve
The numbers for the window.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
Objetos
MailboxInsightsobject
objectstringObligatorio- Uno de
"mailbox_insights" fromstringObligatorio- Formato
date-time tostringObligatorio- Formato
date-time grainstringObligatorio- Uno de
"minute""hour""day"Predeterminado"day" offsetMinutesintegerObligatorioscannedintegerObligatorioConversations that arrived inside the window.
daysobject[]ObligatoriodaystringObligatorioThe bucket:
YYYY-MM-DD,YYYY-MM-DDTHHorYYYY-MM-DDTHH:MMbygrain.countintegerObligatorio
hoursobject[]ObligatoriohourintegerObligatorioThe hour of the day, 0 to 23, in
offsetMinutes.countintegerObligatorio
addressesobject[]ObligatorioaddressstringObligatorioThe address the mail arrived at.
countintegerObligatorio
sendersobject[]ObligatorioThe senders who wrote most, most first.
emailstringnamestring- Puede ser null
countintegerlastAtstring- Formato
date-time
senderCountintegerObligatorioEveryone who wrote inside the window.
waitingobject[]ObligatorioConversations whose last message came from somebody else, by how many days it has waited.
bandintegerObligatorioAt least this many days.
countintegerObligatorio
unattributedintegerObligatorioMail that recorded no address it arrived at.
foldersobject[]Obligatoriolabelstringcountintegerunreadinteger
seriesobject[]ObligatorioPer bucket counts for the top addresses and senders, so each can be charted.
kindstringkeystringdaystringcountinteger
SendingAnalyticsobject
objectstringObligatorio- Uno de
"sending_analytics" sincestringObligatorio- Formato
date-time untilstringObligatorio- Formato
date-time grainstringObligatorio- Uno de
"minute""hour""day"Predeterminado"day" offsetMinutesintegerObligatoriototalsobjectObligatoriosendsintegertestSendsintegerrecipientsintegerdeliveredintegerfailedintegerbouncedintegercomplainedintegeruncertainintegerpendinginteger
daysobject[]Obligatoriodaystringsentintegerdeliveredintegerfailedintegerbouncedintegercomplainedinteger
statusesobject[]ObligatorioSends by status.
labelstringObligatorioWhat is counted.
countintegerObligatorio
sourcesobject[]ObligatorioSends by where they came from: the app, the API, a broadcast and the rest.
labelstringObligatorioWhat is counted.
countintegerObligatorio
sendersobject[]ObligatorioSends by the address they went out as.
labelstringObligatorioWhat is counted.
countintegerObligatorio
suppressedobject[]ObligatorioAddresses that were suppressed, by reason.
labelstringObligatorioWhat is counted.
countintegerObligatorio