Listar respostas no Typeform, por uma API

Lista as respostas de um formulário, da mais nova para a mais antiga, com answers, hidden fields, variáveis, metadados e os horários landed_at e submitted_at. Respostas dos últimos 30 minutos podem não aparecer. O corpo traz total_items; para a próxima página, envie o response_id do último item como before.

Identificador
typeform_list_responses

A chamada

POST https://connect.reportei.com/api/tools/typeform_list_responses/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: u6nXL7 in https://mysite.typeform.com/to/u6nXL7.
page_sizeintegerNãoResponses per page, 25 by default and up to 1000.
sincestringNãoOnly responses from this moment on, inclusive: a Unix time in seconds or an ISO 8601 UTC date and time like 2020-03-20T14:00:59.
untilstringNãoOnly responses up to this moment, inclusive: a Unix time in seconds or an ISO 8601 UTC date and time like 2020-03-20T14:00:59.
beforestringNãoPagination cursor: a response_id from List responses, for the responses submitted before it. Cannot be combined with sort.
afterstringNãoPagination cursor: a response_id from List responses, for the responses submitted after it. Cannot be combined with sort.
included_response_idsstringNãoOnly these responses: response_id values from List responses, separated by commas.
excluded_response_idsstringNãoLeaves out these responses: response_id values from List responses, separated by commas.
response_typestringNãoResponse states, separated by commas: started, partial and completed. completed by default. It also picks the time that since and until compare: submitted_at for completed, staged_at for partial and landed_at for started.
sortstringNãofield,direction: a field id from Get form or submitted_at, staged_at or landed_at, then asc or desc, like submitted_at,desc.
querystringNãoOnly responses whose answers, hidden fields or variables contain this exact phrase.
fieldsstringNãoField ids from Get form, separated by commas, to keep in the answers. The other answers come back as null.
answered_fieldsstringNãoField ids from Get form, separated by commas: only responses that answered at least one of them.

Conexões possíveis

O seu cliente conecta a conta do Typeform 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.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/typeform, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/typeform_list_responses. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Typeform

Ver as 9 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.