Relatório de e-mail marketing do período
Rota de Relatórios da API aberta da Astrify Flows: parâmetros, exemplos em curl, Node.js e Python, resposta e erros.
GEThttps://api2.astrify.com.br/v1/relatorios/email-marketing
Escopo: relatorios:read · Área: Relatórios · Testar no navegador
Visão geral do período (AAAA-MM-DD): totais, taxas, série diária, links, dispositivos, horários. campanha_id filtra uma campanha.
inicio e fim no formato AAAA-MM-DD.
Parâmetros de query
| Nome | Tipo | Descrição |
|---|---|---|
inicio obrigatório | string | — |
fim obrigatório | string | — |
campanha_id | uuid | — |
Exemplo de requisição
A chave vem da variável de ambiente ASTRIFY_API_KEY. Troque os marcadores em maiúsculas (comoLEAD_ID) por ids da sua empresa.
curl "https://api2.astrify.com.br/v1/relatorios/email-marketing?inicio=INICIO&fim=FIM" \ -H "Authorization: Bearer $ASTRIFY_API_KEY"const res = await fetch('https://api2.astrify.com.br/v1/relatorios/email-marketing?inicio=INICIO&fim=FIM', { headers: { Authorization: `Bearer ${process.env.ASTRIFY_API_KEY}`, },});console.log(res.status, await res.json());import os, requests
r = requests.get( "https://api2.astrify.com.br/v1/relatorios/email-marketing?inicio=INICIO&fim=FIM", headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"}, timeout=20,)print(r.status_code, r.json())Resposta
Status 200, em JSON:
{ "data": { "totais": { "enviados": 1280, "aberturas": 540, "cliques": 120 }, "serie": [], "links": [], "dispositivos": [] }}Erros
| Status | Quando acontece |
|---|---|
401 | Chave ausente, inválida, expirada ou revogada. |
403 | Sem o escopo exigido, cargo sem permissão, IP não autorizado ou registro de outra empresa. |
422 | Corpo ou parâmetro com formato inválido. O detail lista os campos com problema. |
429 | Limite de 120 requisições por minuto da chave. Espere o tempo do cabeçalho Retry-After. |
O formato dos erros e as retentativas estão em Limites de uso e erros.