تحلیل‌ها
هر عملیات در این گروه: آنچه می‌پذیرد، آنچه برمی‌گرداند و خطاهایی که ممکن است با آن‌ها پاسخ دهد.
عملیات‌ها
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الزامی