Crear colector en SurveyMonkey, con una API
Crea un colector para una encuesta. Un colector weblink devuelve el enlace para compartir en url, y es el único tipo que puede crear el plan gratuito. Un colector email solo prepara la invitación: destinatarios y envío quedan en SurveyMonkey.
- Identificador
- surveymonkey_create_collector
La llamada
POST https://connect.reportei.com/api/tools/surveymonkey_create_collector/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"survey_id": "<survey_id>",
"type": "weblink",
"name": "<name>"
}
}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 |
|---|---|---|---|
| survey_id | string | Sí | Id of the survey, from List surveys. |
| type | string | Sí | weblink gives a link to share, returned in url. email needs a paid plan, and its invitations are sent from SurveyMonkey.Valores: weblink, email |
| name | string | Sí | Name of the collector, shown only to the account. |
| thank_you_page | object | No | Custom thank-you page shown after a response. |
| redirect_type | string | No | End of the survey: url goes to redirect_url (or the standard thank-you page when it is empty), close closes the window and loop starts over, only for a weblink with allow_multiple_responses.Valores: url, close, loop |
| redirect_url | string | No | URL the respondent goes to after finishing. |
| close_date | string | No | When the collector stops accepting responses, as an ISO 8601 date and time. |
| closed_page_message | string | No | Message shown when the collector is closed. |
| response_limit | integer | No | Closes the collector after this many responses. |
| allow_multiple_responses | boolean | No | Lets the same browser answer more than once. Not for email collectors. |
| anonymous_type | string | No | Turns off IP tracking; in an email collector, fully_anonymous also drops the email and name of the respondent.Valores: not_anonymous, partially_anonymous, fully_anonymous |
| edit_response_type | string | No | When a respondent can still change the answers.Valores: until_complete, never, always |
| display_survey_results | boolean | No | Shows the current results to the respondent at the end. |
| password | string | No | Password the respondent must type to open the survey. |
| disqualification_message | string | No | Message for a respondent who is disqualified by the survey logic. |
| disqualification_url | string | No | URL a disqualified respondent goes to. |
Conexiones posibles
Tu cliente conecta su cuenta de SurveyMonkey una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/surveymonkey, 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/surveymonkey_create_collector. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de SurveyMonkey
- Listar encuestasGETLista las encuestas que la cuenta posee o que se compartieron con ella, con id, título y nickname; include agrega conteos, fechas y enlaces. Pagina con page mientras la respuesta tenga links.next.
- Listar carpetas de encuestasGETLista las carpetas de encuestas de la cuenta con id, título y número de encuestas. Pagina con page mientras la respuesta tenga links.next.
- Obtener encuestaGETDevuelve la encuesta completa: configuración, los enlaces de edición, vista previa, recolección y análisis, y cada página con sus preguntas y opciones de respuesta, todos con sus ids. Las herramientas de respuestas y Listar resúmenes de la encuesta se refieren a estos ids.
- Crear encuestaPOSTCrea una encuesta: vacía, copiada de otra encuesta con from_survey_id, o con sus páginas y preguntas en pages. Devuelve el id de la encuesta y sus enlaces de edición, vista previa y recolección. Aún necesita un colector para recibir respuestas.
- Actualizar encuestaPATCHCambia el título, nickname, idioma, textos de los botones, variables personalizadas, pie de página o carpeta de una encuesta. Las páginas y preguntas quedan como están.
- Listar colectoresGETLista los colectores de una encuesta, las formas en que recibe respuestas, como un enlace web o una invitación por email, con id y nombre; include agrega type, status, url y response_count. Pagina con page mientras la respuesta tenga links.next.
- Actualizar colectorPATCHCambia un colector: lo cierra o lo reabre con status, o cambia su nombre, fecha de cierre, límite de respuestas, mensajes y redirección.
- Listar respuestasGETLista las respuestas de una encuesta con todas las respuestas dadas, como ids de pregunta, opción y fila, más los textos cuando simple es true. En el plan gratuito solo vuelven las primeras 25 respuestas de cada encuesta, y pedir más devuelve el error 1005. Pagina con page mientras la respuesta tenga links.next.
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.
