Listar respuestas en SurveyMonkey, con una API

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

Identificador
surveymonkey_list_responses

La llamada

POST https://connect.reportei.com/api/tools/surveymonkey_list_responses/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.
pageintegerNoPage of results, starting at 1.
per_pageintegerNoResponses per page, 50 by default and up to 100.
simplebooleanNotrue adds the question and answer texts next to the ids.
collector_idsstringNoOnly responses from these collectors: ids from List collectors, separated by commas.
statusstringNoOnly responses with this status.Valores: completed, partial, overquota, disqualified
start_created_atstringNoOnly responses started after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
end_created_atstringNoOnly responses started before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
start_modified_atstringNoOnly responses changed after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
end_modified_atstringNoOnly responses changed before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
emailstringNoOnly responses of this recipient email, for email collectors.
page_idsstringNoOnly the answers of these pages: page ids from Get survey, separated by commas.
question_idsstringNoOnly the answers of these questions: question ids from Get survey, separated by commas.
custom_variablesstringNoOnly responses with these custom variable values, as name and value pairs separated by commas, each part in single quotes and joined by an equals sign, like 'source'='instagram'.
sort_bystringNoField the responses are sorted by.Valores: date_modified
sort_orderstringNoAscending or descending order.Valores: ASC, DESC

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