분석
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
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필수