Subscriber.Interactions

Esta API permite consultar eventos relacionados à interação do cliente final com campanhas de e-mail, incluindo aberturas, cliques, rejeições (bounces) e demais ações que refletem o engajamento deste com a marca.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retornos

  • Success = {true | false}
    Mostra se houve erro ou não

  • ErrorCode = {integer | array de integers}
    Se houve erro, apresenta o código de erro. Neste endpoint os erros vêm como array (ex.: [1]); no sucesso é 0.

  • ErrorText = {text}
    Se houve erro, apresenta o texto do erro

  • Result = {object}
    Resultado da consulta, com Subscriber (SubscriberID, ListID, ListName, Email) e Interactions (array de Date, Type, Kind, AdditionalData)

  • TotalInteractions = {integer}
    Número de interações retornadas em Result.Interactions

Códigos de Erro

  • 0 - APIKey não informada
  • 1 - SubscriberID e ListID são obrigatórios
  • 2 - EmailAddress, ou SubscriberID e ListID, deve ser informado
  • 3 - Nenhuma lista encontrada para os parâmetros informados
  • 99998 - Falha de autenticação ou sessão expirada
  • 99999 - Sem privilégios suficientes
Query Params
string
required

Chave de autenticação.

string
required
Defaults to JSON

Formato do retorno.

string
required
Defaults to Subscriber.Interactions

Comando da API.

string

E-mail do contato que será consultado.

string

ID do contato que será consultado.

string

ID da Lista onde o contato está cadastrado.

Response
200
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!