Listar respostas do formulário no Tally, por uma API

Lista as respostas de um formulário, cada uma com id, isCompleted, submittedAt, os links de prévia e PDF e seus responses, além das perguntas do formulário, de modo que cada resposta se associa a uma pergunta por questionId. Pagine com page enquanto hasMore for true.

Identificador
tally_list_form_submissions

A chamada

POST https://connect.reportei.com/api/tools/tally_list_form_submissions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "form_id": "<form_id>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
form_idstringSimId of the form, from List forms or from the form URL: wA0Bc1 in https://tally.so/r/wA0Bc1.
filterstringNãoWhich submissions to return.Valores: all, completed, partial
startDatestringNãoOnly submissions from this moment on, as an ISO 8601 date and time.
endDatestringNãoOnly submissions up to this moment, as an ISO 8601 date and time.
afterIdstringNãoOnly submissions that came after this one: a submission id from List form submissions.
pageintegerNãoPage of results, starting at 1.
limitintegerNãoSubmissions per page, 50 by default and up to 500.

Conexões possíveis

O seu cliente conecta a conta do Tally uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/tally_list_form_submissions. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Tally

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.