Pular para o conteúdo
Formulários

Listar respostas de um formulário

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/forms/{id}/responses
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposforms.read

Por padrão só as ENVIADAS; status=partial traz as que a pessoa começou e abandonou. answers traz cada resposta em texto, cortada em 200 caracteres (o texto inteiro está no detalhe). Pergunta que a lógica condicional escondeu aparece em hidden, não como vazia.

Contato na Lixeira não sai: a resposta continua, com contactId, contactName e contactPhone nulos. O que a pessoa digitou (answers) fica como foi respondido, inclusive nome, telefone e e-mail, se o formulário os pediu.

Filtros: origin, utmSource, from/to (dias, inclusivos). Paginado por cursor; limit até 50 (padrão 25) — mantenha o mesmo limit ao seguir o cursor.

Parâmetros de caminho

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

  • idstringobrigatório
    • tamanho 1–64

Parâmetros de consulta

Vão na querystring, depois do ?.

  • statusstringopcional
    • um de"submitted""partial"
  • originstringopcional
    • um de"public""internal"
  • fromstring (date)opcional
    • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…
  • tostring (date)opcional
    • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…
  • utmSourcestringopcional
    • tamanho 1–255
  • cursorstringopcional
  • limitintegeropcional
    • padrão 25
    • faixa 1–50

Respostas

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

200Deu certoapplication/json

Respostas do formulário, da mais recente para a mais antiga, e questions — as perguntas que já tiveram resposta, para ler answers.

V1FormResponsePage

  • Cada item — V1FormResponse

    • idstring
    • formIdstring
    • receivedAtstring
    • statusstring
      • um de"submitted""partial"
    • originstring
      • um de"public""internal"
    • versioninteger
    • respondedByUserIdstring | null
    • contactIdstring | null
    • contactNamestring | null
    • contactPhonestring | null
    • hiddenstring[]
      • sourcestring | null
      • mediumstring | null
      • campaignstring | null
      • termstring | null
      • contentstring | null
      • statestring
        • um de"agendado""pendente""sem_horario"
      • startAtstring | null
      • endAtstring | null
    • answersobjeto de string
      • chave string
      • valor string
  • nextCursorstring | null

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

  • Cada item — V1FormQuestion

    • namestring
    • labelstring
    • typestring