Saltar al contenido principal
Referencia de la API

Estadísticas

Métricas de envío por período.

Métricas de envío

GEThttps://api.coffeemail.com.br/v1/product/stats200

Parámetros de consulta

domainIdstring (uuid)
Filtra estatísticas por domínio de envio
tagstring
Filtra estatísticas por tag de campanha
startDatestring
Início do intervalo de datas para o filtro (inclusivo)
endDatestring
Fim do intervalo de datas para o filtro (inclusivo)
granularity"day" | "week" | "month"
Agrupamento dos dados: dia, semana ou mês
period"last7d" | "last30d" | "last90d"
Atalho para intervalo relativo (últimos 7/30/90 dias)
emailType"all" | "transactional" | "broadcast"
Filtra estatísticas por tipo de email: all, transactional ou broadcast
includestring
Blocos extras separados por vírgula; hoje: topTags

Respuesta 200

totalSentintegermín. 0máx. 9007199254740991obligatorio
Total de emails enviados no período
totalDeliveredintegermín. 0máx. 9007199254740991obligatorio
Total de emails entregues com sucesso
totalBouncedintegermín. 0máx. 9007199254740991obligatorio
Total de emails que retornaram como bounce
totalFailedintegermín. 0máx. 9007199254740991obligatorio
Total de emails que falharam no envio
totalComplainedintegermín. 0máx. 9007199254740991obligatorio
Total de emails marcados como spam pelo destinatário no período
complaintRatenumbermín. 0máx. 100obligatorio
Reclamações ÷ entregues, em porcentagem com duas casas
totalOpenedintegermín. 0máx. 9007199254740991obligatorio
Total de emails abertos no período
totalClickedintegermín. 0máx. 9007199254740991obligatorio
Total de links clicados no período
deliveryRatenumbermín. 0máx. 100obligatorio
Taxa de entrega percentual
openRatenumbermín. 0máx. 100obligatorio
Taxa de abertura percentual
clickRatenumbermín. 0máx. 100obligatorio
Taxa de cliques percentual
breakdownobject
Divisão de métricas entre transacionais e broadcasts
breakdown.transactionalobjectobligatorio
breakdown.broadcastobjectobligatorio
topClientsarray<object>obligatorio
Distribuição dos principais clientes de email
topTagsarray<object>
As 5 tags mais usadas no período; só vem com include=topTags
dataarray<object>obligatorio
Série histórica de estatísticas agrupada por período