Pular para o conteúdo principal

Listar campanhas

POST 
/campaigns

Lista as campanhas do site com resultados de envio (analytics), filtros por período e status, e paginação por cursor.

Enviando o corpo vazio ({}) você recebe as 10 campanhas criadas mais recentemente.

Atenção ao campo status: no filtro ele aceita draft, scheduled, sent e failed. Dentro de cada campanha da resposta, o status mostra o valor original (published, draft ou failed) — uma campanha já enviada aparece como published.

Paginação. Cada resposta traz no máximo limit campanhas. Para pegar o resto:

  1. Chame sem cursor para receber a primeira página.
  2. Se a resposta vier com hasMore: true, copie o valor de nextCursor.
  3. Chame de novo mandando esse valor em cursor, repetindo os mesmos filtros e o mesmo limit.
  4. Siga assim até hasMore vir false — nesse ponto nextCursor vem null e acabaram as campanhas.

Os exemplos "Primeira página" e "Próxima página", tanto na requisição quanto na resposta, mostram esse vai e volta com o cursor.

Request​

Responses​

Lista de campanhas

Última atualização em