Listar formularios en Tally, con una API
Lista los formularios con id, name, workspaceId, status, numberOfSubmissions, isClosed y fechas. Pagina con page mientras hasMore sea true.
- Identificador
- tally_list_forms
La llamada
POST https://connect.reportei.com/api/tools/tally_list_forms/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"workspaceIds": []
}
}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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| workspaceIds | array | No | Only the forms of these workspaces: ids from List workspaces. |
| page | integer | No | Page of results, starting at 1. |
| limit | integer | No | Forms per page, 50 by default and up to 500. |
Conexiones posibles
Tu cliente conecta su cuenta de Tally 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.
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/tally_list_forms. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Tally
- Listar workspacesGETLista los workspaces de la organización con id, name, miembros, invitaciones pendientes y carpetas, cada una con id y name. Pagina con page mientras hasMore sea true.
- Obtener formularioGETDevuelve un formulario con su configuración y todos los bloques, cada uno con uuid, type, groupUuid, groupType y payload. Actualizar formulario recibe los bloques de vuelta en este formato.
- Crear formularioPOSTCrea un formulario a partir de sus bloques y devuelve id, name, workspace y status. El formulario va al workspace predeterminado salvo que se envíe workspaceId.
- Actualizar formularioPATCHCambia el nombre, el estado, la configuración o los bloques de un formulario. Enviar blocks reemplaza todos, así que lee antes el formulario con Obtener formulario; name, status y settings pueden ir solos.
- Listar respuestas del formularioGETLista las respuestas de un formulario, cada una con id, isCompleted, submittedAt, los enlaces de vista previa y PDF y sus responses, además de las preguntas del formulario, de modo que cada respuesta se asocia con una pregunta por questionId. Pagina con page mientras hasMore sea true.
- Obtener respuesta del formularioGETDevuelve una respuesta con todos sus responses y las preguntas del formulario.
- Obtener métricas del formularioGETDevuelve los totales de un formulario en el período: visitas, vistas totales, inicios, respuestas, finalizaciones, respondientes únicos, tasa de finalización y las duraciones medias de visita y de finalización.
- Obtener visitas del formularioGETDevuelve las visitas de un formulario en el período, como conteos por intervalo.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
