アナリティクス
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
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以上525600以下grainstringHow 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必須