Saltar para a documentação
API

Ler como chega o correio

Como chega o correio, tal como a página Análises da aplicação o mostra.

GET/analytics/mailbox

Executa a chamada real no seu espaço de trabalho.

GET /analytics/mailbox

Como chega o correio, tal como a página Análises da aplicação o mostra.

Exemplo

Requer threads:read. O período são os últimos 30 dias, a menos que from e to digam o contrário, dividido em dias, ou em horas ou minutos com grain. Passe offsetMinutes, os minutos do leitor a leste de UTC, para que o dia mude à mesma hora que o dele.

curl
curl "$OE/analytics/mailbox?offsetMinutes=120" -H "$AUTH"
Resposta
{  "object": "mailbox_insights",  "from": "2026-09-02T09:00:00.000Z",  "to": "2026-10-02T09:00:00.000Z",  "grain": "day",  "offsetMinutes": 120,  "scanned": 486,  "days": [    { "day": "2026-09-30", "count": 21 },    { "day": "2026-10-01", "count": 17 }  ],  "hours": [    { "hour": 9, "count": 64 },    { "hour": 14, "count": 51 }  ],  "addresses": [{ "address": "[email protected]", "count": 301 }],  "senders": [    {      "email": "[email protected]",      "name": "Ada Lovelace",      "count": 18,      "lastAt": "2026-10-01T16:20:11.000Z"    }  ],  "senderCount": 132,  "waiting": [    { "band": 1, "count": 6 },    { "band": 3, "count": 2 },    { "band": 7, "count": 1 }  ],  "unattributed": 0,  "folders": [{ "label": "inbox", "count": 412, "unread": 9 }],  "series": []}

scanned conta as conversas que chegaram dentro do período. days distribui-as pelos intervalos e hours pelas horas do dia, addresses conta-as pelo endereço a que chegaram, e senders indica as pessoas que mais escreveram. waiting conta as conversas que ainda esperam resposta ao fim de 1, 3 e 7 dias, e folders o que cada pasta contém.

Uma chave ou uma aplicação limitada a certos endereços conta apenas o correio que chegou a esses endereços. address restringe tudo a um só endereço, e um endereço fora do alcance da chave não conta nada, em vez de falhar.

Referência