Pular para o conteúdo
Automações

Histórico de execuções de uma automação

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/automations/{id}/runs
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposautomations.read

Cada vez que a automação disparou: em quem agiu (target), a situação (concluída, em espera, aguardando aprovação, deu erro, cancelada…), quantas Ações gerou e o erro, quando houve. q busca pelo contato (nome, telefone, e-mail) ou pelo título do negócio; situation filtra. Paginado por cursor; limit até 100 (padrão 20).

Contato ou negócio na Lixeira não sai: a execução continua, com target.id e target.label nulos, e o q não o acha (a Lixeira fica fora da API).

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho 1–80

Parâmetros de consulta

Vão na querystring, depois do ?.

  • situationstringopcional

    running = em andamento (inclui em espera); failed = deu erro; awaiting_approval; completed; cancelled.

    • um de"running""failed""awaiting_approval""completed""cancelled"
  • qstringopcional

    Busca pelo contato (nome, telefone, e-mail) ou título do negócio.

    • tamanho 1–120
  • cursorstringopcional
  • limitintegeropcional
    • padrão 20
    • faixa 1–100

Respostas

7 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Execuções da automação, da mais recente para a mais antiga. nextCursor: null = acabou.

  • Cada item — V1AutomationRun

    • idstring
    • situationstring
    • startedAtstring
    • endedAtstring | null
    • triggerTypestring
      • kindstring | null
      • idstring | null
      • labelstring | null
    • actionsCountinteger
    • sleepUntilstring | null
    • cancelReasonstring | null
    • cancelNotestring | null
    • errorstring | null
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.