दस्तावेज़ पर जाएँ
API

एनालिटिक्स

इस समूह का हर ऑपरेशन: वह क्या लेता है, क्या लौटाता है और किन त्रुटियों के साथ जवाब दे सकता है।

ऑपरेशन

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

स्कोपthreads:readपढ़ता है

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.

क्वेरी पैरामीटर

fromstring

The start of the window, ISO 8601 with a zone. Defaults to 30 days before to.

फ़ॉर्मैटdate-time
tostring

The end of the window. Defaults to now.

फ़ॉर्मैटdate-time
offsetMinutesinteger

Minutes 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डिफ़ॉल्ट0
grainstring

How wide one bucket of days and series is.

इनमें से एक"minute""hour""day"डिफ़ॉल्ट"day"
addressstring

Count only the mail delivered to this address. One the key does not reach counts nothing.

3 से 320 वर्ण

लौटाता है

The numbers for the window.

त्रुटियाँ

वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404422500त्रुटि सूची

इनमें भी उपलब्ध

SDK
analytics.mailbox()
CLI
openemail analytics mailbox
MCP
getMailboxInsights

GET/analytics/sending

Read what became of sent mail

स्कोपemails:readपढ़ता है

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.

क्वेरी पैरामीटर

daysinteger

Window length in days.

कम से कम 1अधिकतम 365डिफ़ॉल्ट30
minutesinteger

Window length in minutes, which wins over days.

कम से कम 1अधिकतम 525600
grainstring

How wide one bucket of days is.

इनमें से एक"minute""hour""day"डिफ़ॉल्ट"day"
offsetMinutesinteger

Minutes east of UTC to cut the buckets in, from -840 to 840.

कम से कम -840अधिकतम 840डिफ़ॉल्ट0
addressstring

Count only the mail sent from this address. One the key does not reach counts nothing.

3 से 320 वर्ण

लौटाता है

The numbers for the window.

त्रुटियाँ

वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404422500त्रुटि सूची

इनमें भी उपलब्ध

SDK
analytics.sending()
CLI
openemail analytics sending
MCP
getSendingAnalytics

ऑब्जेक्ट

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-DDTHH or YYYY-MM-DDTHH:MM by grain.

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.

emailstring
namestring
null हो सकता है
countinteger
lastAtstring
फ़ॉर्मैट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[]आवश्यक
labelstring
countinteger
unreadinteger
seriesobject[]आवश्यक

Per bucket counts for the top addresses and senders, so each can be charted.

kindstring
keystring
daystring
countinteger

SendingAnalyticsobject

objectstringआवश्यक
इनमें से एक"sending_analytics"
sincestringआवश्यक
फ़ॉर्मैटdate-time
untilstringआवश्यक
फ़ॉर्मैटdate-time
grainstringआवश्यक
इनमें से एक"minute""hour""day"डिफ़ॉल्ट"day"
offsetMinutesintegerआवश्यक
totalsobjectआवश्यक
sendsinteger
testSendsinteger
recipientsinteger
deliveredinteger
failedinteger
bouncedinteger
complainedinteger
uncertaininteger
pendinginteger
daysobject[]आवश्यक
daystring
sentinteger
deliveredinteger
failedinteger
bouncedinteger
complainedinteger
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आवश्यक