Como obter análises de campanha via API

Este guia explica como recuperar analytics de campanhas e dados de engajamento dos destinatários usando a API da Snov.io.

A API de Analytics e Relatórios da Snov.io fornece acesso aos dados de desempenho das suas campanhas de prospecção. Recupere o progresso das campanhas, métricas de engajamento e atividades dos destinatários em campanhas de e-mail e LinkedIn por meio de solicitações de API.

O que você pode fazer com esta API:

1) Monitorar os resultados das campanhas em e-mail e LinkedIn

2) Sincronizar o engajamento dos destinatários com seu CRM

3) Criar dashboards e relatórios internos

4) Coordenar fluxos de trabalho com base em respostas, aberturas ou cliques

Use o método Autenticação para obter um access_token. Inclua-o como token Bearer em todas as solicitações. O token é válido por 1 hora (3600 segundos).

Consultar campanhas e progresso

Visualizar todas as campanhas

Recupere uma lista de todas as campanhas da sua conta Snov.io, incluindo seus IDs e informações básicas.

Use este método para obter os IDs das campanhas necessários para solicitar dados em outros métodos.

Dados fornecidos:

• ID da campanha
• Nome da campanha
• Status da campanha
• Data de criação

Visualizar o progresso de uma campanha

Verifique o status atual e o progresso de conclusão de uma campanha específica.

Use este método para monitorar se uma campanha está em execução, concluída, pausada ou requer atenção.

Parâmetro obrigatório:

• campaign_id — ID da campanha

Dados fornecidos:

• status: status atual da campanha (active, paused, completed, archived)
• progress: mostra a porcentagem de prospects que chegaram à última etapa da sequência e a porcentagem para os quais a campanha foi encerrada antecipadamente devido a bounce, resposta, resposta automática, descadastro, exclusão ou remoção manual
• unfinished: número de destinatários programados para receber as próximas etapas da sequência

Estatísticas e relatórios de campanha

Use os métodos a seguir para recuperar métricas de engajamento e desempenho das campanhas.

Obter analytics de campanhas

Recupere estatísticas agregadas de desempenho das suas campanhas.

Use este método para criar relatórios, monitorar KPIs de prospecção e sincronizar estatísticas de campanhas com dashboards externos ou ferramentas de analytics.

Parâmetros obrigatórios:

Especifique o intervalo de datas para o qual deseja recuperar as estatísticas.

• date_from — data inicial do período do relatório (AAAA-MM-DD)
• date_to — data final do período do relatório (AAAA-MM-DD)

Os parâmetros opcionais funcionam como filtros para restringir os dados retornados.

• campaign_id — recuperar analytics de uma campanha específica
• campaign_owner — recuperar analytics de um membro específico da equipe
• sender_email — recuperar analytics de uma conta de e-mail remetente específica
• sender_linkedin — recuperar analytics de um perfil específico do LinkedIn

Dados fornecidos:

A resposta contém dados agregados de desempenho dos canais de e-mail e LinkedIn:

• Métricas gerais de outreach: total de prospects alcançados, e-mails agendados, e-mails enviados, total de bounces detectados
• Métricas de engajamento por e-mail: aberturas, cliques, respostas, descadastros, taxa de abertura, taxa de cliques, taxa de resposta
• Métricas de atividade no LinkedIn: convites enviados, convites aceitos, mensagens enviadas, respostas recebidas

Obter atividade dos destinatários da campanha

Recupere dados detalhados de engajamento de todos os destinatários de uma campanha, incluindo interações por e-mail e LinkedIn.

Use este método para sincronizar dados de engajamento com seu CRM, plataforma de analytics ou ferramentas de relatórios.

Parâmetro obrigatório:

• campaign_id — ID da campanha

Dados fornecidos:

• Dados do prospect: nome, e-mail
• Atividade por e-mail de cada destinatário: e-mails enviados, e-mails abertos, cliques, respostas, bounces
• Atividade por LinkedIn de cada destinatário: convites enviados e aceitos, mensagens enviadas, e respostas aceitas
• Data e hora de cada evento de engajamento

Obter respostas de uma campanha

Recupere as respostas por e-mail recebidas em uma campanha específica.

Use este método para enviar dados de respostas para seu CRM ou fluxos de automação quando precisar apenas das respostas por e-mail, sem incluir respostas do LinkedIn. Para obter respostas do LinkedIn (convites, mensagens diretas ou InMails), use o método Obter todas as respostas da campanha.

Parâmetro obrigatório:

• campaign_id — ID da campanha

Dados fornecidos:

• Dados do prospect: nome e endereço de e-mail
• Assunto e corpo da mensagem de e-mail
• Etapa da sequência que gerou a resposta(step_number)
• Sentimento da resposta identificado por IA (mood)
• Data e hora da resposta

Obter todas as respostas da campanha

Recupere todas as respostas recebidas em uma campanha específica, tanto de e-mail quanto de LinkedIn.

Use este método para monitorar respostas dos prospects e alimentar seu CRM ou fluxos de automação com esses dados.

Parâmetro obrigatório:

• campaign_id — ID da campanha

Dados fornecidos:

• Dados do prospect: nome e endereço de e-mail
• Tipo de resposta: resposta por e-mail ou resposta pelo LinkedIn
• Assunto e corpo da mensagem de e-mail
• Conteúdo da resposta no LinkedIn
• Etapa da sequência que gerou a resposta(step_number)
• Sentimento da resposta identificado por IA (mood)
• Data e hora da resposta

Obter aberturas de e-mail

Recupere dados sobre os destinatários que abriram e-mails de uma campanha.

Use este método para monitorar o engajamento por e-mail e medir taxas de abertura.

Parâmetro obrigatório:

• campaign_id — ID da campanha

Dados fornecidos:

• Dados do prospect: nome e endereço de e-mail
• Número de vezes que o e-mail foi aberto
• Data e hora da primeira abertura e da abertura mais recente

Obter cliques em links

Recupere dados sobre os destinatários que clicaram em links nos e-mails da campanha.

Use este método para acompanhar o engajamento por cliques e o desempenho do conteúdo.

Parâmetro obrigatório:

• campaign_id — ID da campanha

Dados fornecidos:

• Dados do prospect: nome e endereço de e-mail
• URL clicada
• Número de cliques por destinatário
• Data e hora do clique

Obter e-mails enviados

Recupere uma lista dos e-mails enviados em uma campanha.

Use este método para validar registros de entrega e acompanhar a atividade de envio.

Parâmetro obrigatório:

• campaign_id — ID da campanha

Dados fornecidos:

• Dados do prospect: nome e endereço de e-mail
• Conta de remetente utilizada
• Assunto do e-mail
• Número da etapa da sequência
• Data e hora do envio

Obter prospects que concluíram a campanha

Recupere os prospects que concluíram todas as etapas de uma sequência de campanha.

Use esses dados para identificar destinatários que finalizaram a sequência e podem precisar de acompanhamento ou inclusão em outra campanha.

Required parameter:

• campaign_id — ID da campanha

What data it provides:

• Dados do prospect: nome e endereço de e-mail
• Data em que o prospect concluiu a sequência
• Última etapa da sequência alcançada