Перейти к документации
MCP-сервер

Аналитика

Как приходит почта и что стало с отправленной почтой.

Инструменты аналитики

ИнструментЧто делает
getMailboxInsightsКак приходит почта за период, в том виде, в каком её показывает страница «Аналитика»: по дням и по часам, по адресам и по отправителям, что ждёт ответа, и папки.
getSendingAnalyticsЧто стало с почтой, которую рабочее пространство отправило за период, в том виде, в каком это показывает страница «Аналитика»: доставленные, неудавшиеся, с отказом доставки и с жалобами, по дням.

Чтение того, как приходит почта, требует «Read threads and messages» (threads:read), а чтение того, что стало с отправленной почтой, требует «Read sent messages and their delivery status» (emails:read). Клиент, ограниченный некоторыми адресами, считает только почту, пришедшую на них или отправленную с них, а address сужает любой из подсчётов до одного адреса.

Справочник

getMailboxInsights

Разрешенияthreads:readАссистент в приложении выполняет его без вопросовНабор инструментовinsights

How mail arrives, as the Analytics page shows it: how many conversations came in over a window and on which days, the busiest hours, the addresses they arrived at, the senders who wrote most, how many wait on a reply, and the folders. from and to are ISO 8601 instants and default to the last 30 days. offsetMinutes is the reader’s minutes east of UTC, so days break where theirs do. address narrows it to one address.

Входные данные

fromstring
Форматdate-time
tostring
Форматdate-time
grainstring
Одно из"minute""hour""day"
offsetMinutesinteger
Не меньше -840Не больше 840
addressstring
От 3 до 320 символов

Также доступно в

API
GET /analytics/mailbox
SDK
analytics.mailbox()

getSendingAnalytics

Разрешенияemails:readАссистент в приложении выполняет его без вопросовНабор инструментовinsights

What became of the mail this workspace sent, as the Analytics page shows it: how many went out over a window and how many were delivered, failed, bounced or complained about, per day, with the statuses, where they came from, the addresses they went out as and the addresses suppressed. days defaults to 30, minutes wins over days, and address narrows it to the mail sent from one address.

Входные данные

daysinteger
Не меньше 1Не больше 365
minutesinteger
Не меньше 1Не больше 525600
grainstring
Одно из"minute""hour""day"
offsetMinutesinteger
Не меньше -840Не больше 840
addressstring
От 3 до 320 символов

Также доступно в

API
GET /analytics/sending
SDK
analytics.sending()