Saltar para a documentação
API

Ler o crescimento das audiências

Quantos contactos entraram em cada audiência num período que termina agora, contados por dia, hora ou minuto: o gráfico de crescimento da página de audiências. Uma audiência regista quando alguém entrou e nunca quando saiu, por isso cada valor conta as pessoas que continuam hoje na lista, pela data em que entraram, e uma linha nunca desce.

GETapi.openemail.uk/audiences/growth

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

GET /audiences/growth

Quantos contactos entraram em cada audiência num período que termina agora, contados por dia, hora ou minuto: o gráfico de crescimento da página de audiências. Uma audiência regista quando alguém entrou e nunca quando saiu, por isso cada valor conta as pessoas que continuam hoje na lista, pela data em que entraram, e uma linha nunca desce.

Exemplo

Requer audiences:read. Omita audienceIds para todas as audiências, ou indique até 50 separadas por vírgulas. O período é days (1 a 1095) ou minutes (1 a 1576800, que prevalece quando ambos são enviados), 30 dias por omissão. grain é day, hour ou minute, day por omissão, e offsetMinutes (-840 a 840) é o desvio de quem consulta em relação a UTC, para que os intervalos diários comecem à sua meia-noite local.

curl
curl "$OE/audiences/growth?days=30" -H "$AUTH"
Resposta
{  "object": "audience_growth",  "since": "2026-08-25T00:00:00.000Z",  "until": "2026-09-23T12:00:00.000Z",  "grain": "day",  "offsetMinutes": 0,  "totals": {    "contacts": 412,    "memberships": 415,    "added": 37,    "lists": 2,    "busiest": "2026-09-18"  },  "series": [    {      "id": "aud_9f2c4b7e1a0d63d84c5f2e7b",      "name": "All contacts",      "builtin": true,      "total": 412,      "before": 378,      "added": 34,      "buckets": [        { "bucket": "2026-09-14", "added": 9 },        { "bucket": "2026-09-18", "added": 25 }      ]    },    {      "id": "aud_4c1b8e2a7d9f05c36b4e8a71",      "name": "Product updates",      "builtin": false,      "total": 3,      "before": 0,      "added": 3,      "buckets": [{ "bucket": "2026-09-18", "added": 3 }]    }  ]}

total são os membros atuais, before os que, de entre eles, entraram antes de since, e added os que entraram dentro do período, pelo que before mais addedtotal. Um contacto que entrou e depois saiu não está em nenhum deles.

totals.contacts conta cada pessoa uma vez, em quantas listas estiver, enquanto totals.memberships soma as listas, pelo que uma pessoa conta uma vez por cada lista lida que a contém, e a audiência predefinida contém toda a gente. totals.busiest é o intervalo com mais entradas em todas as listas, ou null quando ninguém entrou.

As chaves de intervalo são YYYY-MM-DD por dia, YYYY-MM-DDTHH por hora e YYYY-MM-DDTHH:MM por minuto, na hora local indicada por offsetMinutes. Só são listados os intervalos com alguma entrada, por isso preencha as falhas com zero ao desenhá-los. series está ordenado por total, do maior para o menor, e depois por nome, e builtin é true na audiência predefinida.

Um id em audienceIds que não é uma audiência deste espaço de trabalho dá um 404 audience_not_found, e mais de 50 ids dão um 422 invalid_parameter. O período começa no início do seu primeiro intervalo, pelo que since pode ficar um pouco antes de exatamente days atrás.