Metrics
Métricas do E-goi pela API
Seu cliente conecta a conta do E-goi e seu produto consulta 26 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"comparison_start": "2026-09-01",
"comparison_end": "2026-09-30",
"metrics": [
{
"id": "m1",
"reference_key": "egoi:total_contacts",
"component": "number_v1",
"metrics": [
"total_contacts"
],
"dimensions": [
"contact"
]
}
]
}Mais exemplos de chamadas no E-goi
O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).
Gráfico
Campanhas de e-mail ao longo do tempo
Desempenho de suas campanhas de e-mail durante o período analisado.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "egoi:email_campaigns_over_time",
"component": "chart_v1",
"metrics": [
"sent_emails",
"unique_email_openings",
"clicks"
],
"dimensions": [
"email"
]
}
]
}Tabela
Tabela de desempenho de contatos
Tabela de contatos presentes, assinaturas e remoções.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "egoi:contacts_performance_table",
"component": "datatable_v1",
"metrics": [
"total_subscriptions",
"total_subscriptions_rate",
"total_unsubscriptions",
"total_unsubscriptions_rate",
"total_contacts"
],
"dimensions": [
"contact"
]
}
]
}Número
Inscrições totais
Número total de assinaturas à sua lista de contatos (via formulários, API ou adicionados manualmente) durante o período analisado.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "egoi:total_subscriptions",
"component": "number_v1",
"metrics": [
"total_subscriptions"
],
"dimensions": [
"contact"
]
}
]
}Números
20 métricas
Contatos totais
Número total de contatos presentes em sua conta.
egoi:total_contactsInscrições totais
Número total de assinaturas à sua lista de contatos (via formulários, API ou adicionados manualmente) durante o período analisado.
egoi:total_subscriptionsCancelamentos totais
Número total de contatos removidos da sua conta.
egoi:total_unsubscriptionsEmails enviados
Número total de e-mails enviados por campanhas durante o período analisado.
egoi:sent_emailsAbertura total de emails
Número de vezes que os e-mails foram abertos pelos destinatários.
egoi:total_email_openingsAberturas únicas de email
Número de vezes que os e-mails foram abertos pelos destinatários.
egoi:unique_email_openingsCliques
Total number of clicks that occurred on links embedded in the sent emails.
egoi:clicksCliques únicos
Number of unique recipients who clicked on any tracked link.
egoi:unique_clicksRejeições permanentes
Number of permanent failures in email delivery.
egoi:hard_bouncesRejeições temporárias
Number of temporary failures in email delivery.
egoi:soft_bouncesReclamações
Número de reclamações recebidas sobre suas campanhas de e-mail durante o período analisado.
egoi:complaintsCancelamentos de e-mails
Indica quantos destinatários optaram por serem removidos da lista de e-mails durante o período analisado.
egoi:email_unsubscriptionsTaxa de abertura de e-mails
Porcentagem do total de aberturas de seus e-mails em relação ao total de e-mails enviados.
egoi:email_openings_rateTaxa de abertura única de e-mails
Porcentagem de aberturas únicas dos seus e-mails em relação ao total de e-mails entregues.
egoi:unique_email_openings_rateTaxa de cliques
Porcentagem total de cliques, considerando todos os cliques feitos nos links de e-mail em relação ao total de e-mails enviados.
egoi:clicks_rateTaxa de cliques únicos
Porcentagem de cliques únicos nos seus e-mails em relação ao total de e-mails que foram abertos pelo menos uma vez.
egoi:unique_clicks_rateTaxa de rejeições permanentes
Porcentagem de falhas permanentes na entrega de e-mails.
egoi:hard_bounces_rateTaxa de reclamações
Porcentagem de reclamações recebidas sobre suas campanhas de e-mail durante o período analisado.
egoi:complaints_rateTaxa de cancelamentos de inscrição por e-mail
Porcentagem de destinatários que optaram por serem removidos da lista de e-mails durante o período analisado.
egoi:email_unsubscriptions_rateE-mails entregues
Indica quantos e-mails foram entregues com sucesso aos destinatários, excluindo rejeições.
egoi:delivered_emails
Gráficos
1 métrica
Campanhas de e-mail ao longo do tempo
Desempenho de suas campanhas de e-mail durante o período analisado.
egoi:email_campaigns_over_time
Tabelas
5 métricas
Tabela de desempenho de contatos
Tabela de contatos presentes, assinaturas e remoções.
egoi:contacts_performance_tableDesempenho das campanhas de email
Tabela de desempenho da campanha de e-mail.
egoi:email_campaign_performanceDesempenho de SMS
Tabela de desempenho da campanha de SMS.
egoi:sms_performanceDesempenho de web push
Tabela de desempenho da campanha de web push.
egoi:web_push_performanceDesempenho da automação
Tabela de desempenho da automação.
egoi:automation_performance
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
