Lister les réponses avec l'API SurveyMonkey

Liste les réponses d'une enquête avec toutes les réponses données, sous forme d'ids de question, de choix et de ligne, plus les textes quand simple vaut true. Sur le plan gratuit, seules les 25 premières réponses de chaque enquête reviennent, et en demander davantage renvoie l'erreur 1005. Paginez avec page tant que la réponse contient links.next.

Identifiant
surveymonkey_list_responses

L'appel

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

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
survey_idstringOuiId of the survey, from List surveys.
pageintegerNonPage of results, starting at 1.
per_pageintegerNonResponses per page, 50 by default and up to 100.
simplebooleanNontrue adds the question and answer texts next to the ids.
collector_idsstringNonOnly responses from these collectors: ids from List collectors, separated by commas.
statusstringNonOnly responses with this status.Valeurs : completed, partial, overquota, disqualified
start_created_atstringNonOnly responses started after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
end_created_atstringNonOnly responses started before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
start_modified_atstringNonOnly responses changed after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
end_modified_atstringNonOnly responses changed before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
emailstringNonOnly responses of this recipient email, for email collectors.
page_idsstringNonOnly the answers of these pages: page ids from Get survey, separated by commas.
question_idsstringNonOnly the answers of these questions: question ids from Get survey, separated by commas.
custom_variablesstringNonOnly 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_bystringNonField the responses are sorted by.Valeurs : date_modified
sort_orderstringNonAscending or descending order.Valeurs : ASC, DESC

Connexions possibles

Votre client connecte son compte SurveyMonkey une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/surveymonkey, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/surveymonkey_list_responses. Il devient la définition de tool de votre agent sans conversion.

Autres tools SurveyMonkey

Voir les 11 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.