Buscar respuestas en Typeform, con una API

Busca las respuestas de un formulario por valores de respuesta, tags, hidden fields, metadatos u hora de envío, todas las condiciones juntas. Úsala en lugar de List responses para filtrar por una respuesta. Para la página siguiente, envía el response_id del último elemento como before_response_id.

Identificador
typeform_search_responses

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
form_idstringSíId of the form, from List forms or from the form URL: u6nXL7 in https://mysite.typeform.com/to/u6nXL7.
filter_groupobjectNoConditions that must all match.
response_typearrayNoResponse states to return, completed by default.
sizeintegerNoResponses per page, 25 by default and up to 1000.
sortarrayNoSort 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_idstringNoPagination cursor: a response_id from Search responses, for the responses submitted before it.
after_response_idstringNoPagination cursor: a response_id from Search responses, for the responses submitted after it.
querystringNoOnly responses whose answers, hidden fields or variables contain this exact phrase.
fieldsarrayNoField ids from Get form to keep in the answers. The other answers come back as null.
answered_fieldsarrayNoField ids from Get form: only responses that answered at least one of them.

Conexiones posibles

Tu cliente conecta su cuenta de Typeform una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/typeform, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/typeform_search_responses. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Typeform

Ver las 9 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.