Listar colectores en SurveyMonkey, con una API

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

Identificador
surveymonkey_list_collectors

La llamada

POST https://connect.reportei.com/api/tools/surveymonkey_list_collectors/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>"
  }
}

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
survey_idstringSíId of the survey, from List surveys.
namestringNoOnly the collectors whose name matches this text.
start_datestringNoOnly collectors created after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
end_datestringNoOnly collectors created before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
includestringNoExtra fields, separated by commas: type, status, response_count, date_created, date_modified and url.
sort_bystringNoField the collectors are sorted by.Valores: id, date_modified, type, status, name
sort_orderstringNoAscending or descending order.Valores: ASC, DESC
pageintegerNoPage of results, starting at 1.
per_pageintegerNoResults per page, up to 1000.

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_list_collectors. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de SurveyMonkey

Ver las 11 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.