التحليلات
كل عملية في هذه المجموعة: ما تقبله وما تُرجعه والأخطاء التي قد تردّ بها.
العمليات
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.
معلمات الاستعلام
fromstringThe start of the window, ISO 8601 with a zone. Defaults to 30 days before
to.التنسيقdate-timetostringThe end of the window. Defaults to now.
التنسيقdate-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.
على الأقل -840على الأكثر 840الافتراضي0grainstringHow wide one bucket of
daysandseriesis.أحد"minute""hour""day"الافتراضي"day"addressstringCount only the mail delivered to this address. One the key does not reach counts nothing.
من 3 إلى 320 من الأحرف
يُرجع
The numbers for the window.
الأخطاء
الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء
متاح أيضًا في
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.
معلمات الاستعلام
daysintegerWindow length in days.
على الأقل 1على الأكثر 365الافتراضي30minutesintegerWindow length in minutes, which wins over
days.على الأقل 1على الأكثر 525600grainstringHow wide one bucket of
daysis.أحد"minute""hour""day"الافتراضي"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, from -840 to 840.
على الأقل -840على الأكثر 840الافتراضي0addressstringCount only the mail sent from this address. One the key does not reach counts nothing.
من 3 إلى 320 من الأحرف
يُرجع
The numbers for the window.
الأخطاء
الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء
متاح أيضًا في
الكائنات
MailboxInsightsobject
objectstringمطلوب- أحد
"mailbox_insights" fromstringمطلوب- التنسيق
date-time tostringمطلوب- التنسيق
date-time grainstringمطلوب- أحد
"minute""hour""day"الافتراضي"day" offsetMinutesintegerمطلوبscannedintegerمطلوبConversations that arrived inside the window.
daysobject[]مطلوبdaystringمطلوبThe bucket:
YYYY-MM-DD,YYYY-MM-DDTHHorYYYY-MM-DDTHH:MMbygrain.countintegerمطلوب
hoursobject[]مطلوبhourintegerمطلوبThe hour of the day, 0 to 23, in
offsetMinutes.countintegerمطلوب
addressesobject[]مطلوبaddressstringمطلوبThe address the mail arrived at.
countintegerمطلوب
sendersobject[]مطلوبThe senders who wrote most, most first.
emailstringnamestring- يمكن أن يكون null
countintegerlastAtstring- التنسيق
date-time
senderCountintegerمطلوبEveryone who wrote inside the window.
waitingobject[]مطلوبConversations whose last message came from somebody else, by how many days it has waited.
bandintegerمطلوبAt least this many days.
countintegerمطلوب
unattributedintegerمطلوبMail that recorded no address it arrived at.
foldersobject[]مطلوبlabelstringcountintegerunreadinteger
seriesobject[]مطلوبPer bucket counts for the top addresses and senders, so each can be charted.
kindstringkeystringdaystringcountinteger
SendingAnalyticsobject
objectstringمطلوب- أحد
"sending_analytics" sincestringمطلوب- التنسيق
date-time untilstringمطلوب- التنسيق
date-time grainstringمطلوب- أحد
"minute""hour""day"الافتراضي"day" offsetMinutesintegerمطلوبtotalsobjectمطلوبsendsintegertestSendsintegerrecipientsintegerdeliveredintegerfailedintegerbouncedintegercomplainedintegeruncertainintegerpendinginteger
daysobject[]مطلوبdaystringsentintegerdeliveredintegerfailedintegerbouncedintegercomplainedinteger
statusesobject[]مطلوبSends by status.
labelstringمطلوبWhat is counted.
countintegerمطلوب
sourcesobject[]مطلوبSends by where they came from: the app, the API, a broadcast and the rest.
labelstringمطلوبWhat is counted.
countintegerمطلوب
sendersobject[]مطلوبSends by the address they went out as.
labelstringمطلوبWhat is counted.
countintegerمطلوب
suppressedobject[]مطلوبAddresses that were suppressed, by reason.
labelstringمطلوبWhat is counted.
countintegerمطلوب