Carregando...

Controle de Relatórios

Controle de Relatórios

 

As integrações desse grupo permitem a geração de relatórios  referente aos envios de um período ou ação específica, relatórios de erros  e  retornar os opt-out do dia.

 

11.20 - Histórico de Ações por Período

 

 Essa integração é o primeiro passo para a geração de um relatório com entregas, aberturas e cliques. As informações geradas podem ser relativas a um período ou uma ação específica.  O retorno após a execução de mais 2 integrações (11.21 e 11.22) será o download um arquivo .zip contendo um .csv com as informações conforme o exemplo abaixo:

XML  de Envio:

<main>
  <emkt trans="11.20">
    <data_inicial>AAAA-MM-DD HH:MM:SS</data_inicial>
    <data_final>AAAA-MM-DD HH:MM:SS</data_final>
    <usuario>[E-MAIL DO USUÁRIO]</usuario>
    <novas_colunas>S</novas_colunas>
    <campos>
     <infoadc13>S</infoadc13>
    </campos>
  </emkt>
</main>
*Itens em negrito são obrigatórios
Atenção: A diferença entre a data inicial e data final não pode ser maior que 24 horas.

Caso queira consultar uma ação específica troque:

<data_inicial>AAAA-MM-DD HH:MM:SS</data_inicial>
<data_final>AAAA-MM-DD HH:MM:SS</data_final>

Por:

<acao>[TITULODAACAO]</acao> ou <acao_codigo>[CODIGODAACAO]</acao_codigo>

As colunas código do evento e elemento só são inseridas quando for utilizada a opção:

<novas_colunas>S</novas_colunas>

Utilizando a tag <campos> você pode acrescentar ao relatório gerado campos presentes na lista, sejam eles campos padrões ou campos adicionais. No exemplo abaixo inserimos o campo nome:

<campos>
     <nome>S</nome>
    </campos>

XML de Retorno:

<main>
  <emkt trans="11.20" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <processo>[CODIGO MD5]</processo>
  </emkt>
</main>

 

11.21 - Situação do Processo de Histórico de Ações por Período (11.20)

 

Essa integração é o segundo passo da integração 11.20. Utilize para verificar o status do processo de geração do relatório. Utilize o código do retorno da integração 11.20 para o envio conforme segue abaixo:

XML de Envio:

<main>
  <emkt trans="11.21">
    <processo>[CODIGO MD5]</processo>
  </emkt>
</main>
*Itens em negrito são obrigatórios

XML  de Retorno:

<main>
  <emkt trans="11.21" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
    <progresso>[PERCENTUAL]</progresso>
    <resultado>
      <erro>[MENSAGEM DE ERRO]</erro>
    </resultado>
  </emkt>
</main>

Somente quando o retorno for “100” e não houver mensagem de erro podemos solicitar a 11.22.

 

11.22 - Download do Arquivo Solicitado no Histórico de Ações por Período (11.20)

 

Esse é o terceiro e último passo para geração do relatório de histórico dos contatos. Utilize o código do retorno da integração 11.20 para o envio conforme segue abaixo:

XML de Envio:

<main>
  <emkt trans="11.22">
    <processo>[CODIGO MD5]</processo >
  </emkt>
</main>
*Itens em negrito são obrigatórios

XML de Retorno:

Essa solicitação retorna um arquivo no formato zip, contendo um csv com as seguintes colunas Ação, 
Data e Hora, E-mail, Código externo, Evento (Descrição), Código do Evento e Elemento. 
O csv retornado usará ; (ponto e vírgula) como separador dos campos.
Possibilidades de códigos de eventos:
TE – Troca de e-mail, o elemento terá os dois e-mails separados por
| (pipe), sendo que o primeiro será o e-mail anterior e o segundo o novo e-mail
OO – Opt-out, o elemento será a Área de interesse
OI – Opt-in, o elemento será a Área de interesse
EN – Encaminhamento, o elemento será o e-mail para quem o usuário encaminhou
ET – Entregue, nesse caso não haverá conteúdo em elemento
ER – Erro, o elemento será o erro que ocorreu
VW – Visualizou, nesse caso não haverá conteúdo em elemento
CL – Clique, o elemento será o link onde ocorreu o clique
AC – Alteração de cadastro, caso não haverá conteúdo em elemento
PR – Pedido de remoção, o elemento virá preenchido com o motivo caso esse tenha sido informado.

 

11.30 - Históricos de Erros por Período

 

Utilize essa integração para gerar um relatório com o histórico dos erros dos contatos nas ações.

XML de Envio:

<main>
  <emkt trans="11.30">
    <data_inicial>AAAA-MM-DD HH:MM:SS</data_inicial>
    <data_final>AAAA-MM-DD HH:MM:SS</data_final>
  </emkt>
</main>
*Itens em negrito são obrigatórios
Atenção: A diferença entre a data inicial e data final não pode ser maior que 24 horas.

XML de Retorno:

<main>
  <emkt trans="11.30" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
    <contato>
      <data>[AAAA-MM-DD HH:MM:SS]</data>
      <email>[EMAIL DO CONTATO]</email>
      <acao>[TITULO DA ACAO]</acao>
      <evento>[TIPO DE ERRO]</evento>
    </contato>
  </emkt>
</main>

DATA – Data e hora do histórico.

EMAIL – Email do contato que gerou o histórico.

ACAO – Título da ação que o contato participou.

EVENTO - Tipo de erros que podem ser apresentados:

  • Anti-spam
  • Conteúdo rejeitado
  • Caixa postal cheia
  • Outros
  • Falha de entrega
  • Destinatário desconhecido
  • Servidor desconhecido
  • Caixa postal indisponível

 

11.95 - Retornam os Opt-Out do Dia

 

Utilize essa integração para verificar e/ou exportar os opt-out que ocorreram no dia.

XML de Envio:

<main>
  <emkt trans="11.95">
    <data>AAAA-MM-DD</data>
  </emkt>
</main>
*Itens em negrito são obrigatórios.

XML de Retorno:

<main>
  <emkt trans="11.95" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <contato>
      <datahora>[AAAA-MM-DD HH:MM:SS]</datahora>
      <email>[EMAIL DO CONTATO]</email>
      <acao codigo="[CODIGO DA ACAO]">[NOME DA ACAO]</acao>
      <motivo codigo="[CODIGO DO MOTIVO]">[DESCRICAO DO MOTIVO]</motivo>
      <area codigo="[CODIGO DA AREA]">[NOME DA AREA DE INTERESSE]</area>
    </contato>
    <contato>
    (...)
    </contato>
  </emkt>
</main>
Atenção: Esse processo só considera ações não arquivadas.
Este conteúdo foi útil?32