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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| form_id | string | Sim | Id of the form, from List forms or from the form URL: u6nXL7 in https://mysite.typeform.com/to/u6nXL7. |
| page_size | integer | Não | Responses per page, 25 by default and up to 1000. |
| since | string | Não | Only 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. |
| until | string | Não | Only 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. |
| before | string | Não | Pagination cursor: a response_id from List responses, for the responses submitted before it. Cannot be combined with sort. |
| after | string | Não | Pagination cursor: a response_id from List responses, for the responses submitted after it. Cannot be combined with sort. |
| included_response_ids | string | Não | Only these responses: response_id values from List responses, separated by commas. |
| excluded_response_ids | string | Não | Leaves out these responses: response_id values from List responses, separated by commas. |
| response_type | string | Não | Response 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. |
| sort | string | Não | field,direction: a field id from Get form or submitted_at, staged_at or landed_at, then asc or desc, like submitted_at,desc. |
| query | string | Não | Only responses whose answers, hidden fields or variables contain this exact phrase. |
| fields | string | Não | Field ids from Get form, separated by commas, to keep in the answers. The other answers come back as null. |
| answered_fields | string | Não | Field 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
- Listar workspacesGETLista os workspaces que a conta alcança, entre suas organizações, com id, name, self.href e o número de formulários. Pagine com page até chegar ao page_count da resposta.
- Criar workspacePOSTCria um workspace na organização em que o usuário conectado é proprietário e o retorna com id e self.href.
- Listar formuláriosGETLista os formulários da conta, públicos e privados, com id, título, datas e o link público em _links.display. Pagine com page até chegar ao page_count da resposta.
- Consultar formulárioGETRetorna a definição inteira de um formulário: configurações, tema, workspace, hidden fields, telas, lógica e os campos com seus ids e refs. Os ids dos campos são o que as tools de respostas filtram.
- Criar formulárioPOSTCria um formulário em um workspace e o retorna com id, ids dos campos e o link público em _links.display. Imagens em campos e telas já precisam existir na conta.
- Atualizar formulárioPUTSubstitui a definição inteira de um formulário. Leia-o com Get form, altere o que precisar e envie tudo de volta: cada campo mantém seu id, e um campo deixado de fora é apagado junto com suas respostas nas respostas existentes.
- Buscar respostasPOSTBusca as respostas de um formulário por valores de resposta, tags, hidden fields, metadados ou horário de envio, todas as condições juntas. Use em vez de List responses para filtrar por uma resposta. Para a próxima página, envie o response_id do último item como before_response_id.
- Listar temasGETLista os temas da conta, do mais novo para o mais antigo, com id, nome, cores e fonte. Pagine com page até chegar ao page_count da resposta.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
