Campaign.Get

Retorna uma campanha específica de um usuário

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. Quando um parâmetro obrigatório não é enviado, o retorno é um array (ex.: [1]); nos demais erros é um integer.

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

  • Campaign = {object}
    Dados da campanha solicitada. Além das colunas da campanha, traz as sub-chaves Content (conteúdo do e-mail), Link (links da campanha), SplitTest (dados do teste A/B, quando houver), Tags (quando RetrieveTags = true) e Reports (quando RetrieveStatistics = true)

Códigos de Erro

  • 1 - Faltou o ID da campanha (CampaignID)
  • 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 Campaign.Get

Comando da API

string
required
Defaults to JSON

Formato do retorno

boolean

Envie este parâmetro em caso de cross-domain

int32
required

ID da campanha

boolean

Se for “true”, retorna as estatísticas da campanha (com informações detalhadas)

boolean
Defaults to false

Opcional. Se true, retorna também as tags da campanha. Padrão: false

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