Buscar respostas no Typeform, por uma API

Busca 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.

Identificador
typeform_search_responses

A chamada

POST https://connect.reportei.com/api/tools/typeform_search_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.
filter_groupobjectNãoConditions that must all match.
response_typearrayNãoResponse states to return, completed by default.
sizeintegerNãoResponses per page, 25 by default and up to 1000.
sortarrayNãoSort clauses as field,direction: a field id from Get form or submitted_at, staged_at or landed_at, then asc or desc. Cannot be combined with the cursors.
before_response_idstringNãoPagination cursor: a response_id from Search responses, for the responses submitted before it.
after_response_idstringNãoPagination cursor: a response_id from Search responses, for the responses submitted after it.
querystringNãoOnly responses whose answers, hidden fields or variables contain this exact phrase.
fieldsarrayNãoField ids from Get form to keep in the answers. The other answers come back as null.
answered_fieldsarrayNãoField ids from Get form: 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_search_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.