Créer une enquête avec l'API SurveyMonkey
Crée une enquête : vide, copiée d'une autre enquête avec from_survey_id, ou avec ses pages et questions dans pages. Renvoie l'id de l'enquête et ses liens de modification, d'aperçu et de collecte. Elle a encore besoin d'un collecteur pour recevoir des réponses.
- Identifiant
- surveymonkey_create_survey
L'appel
POST https://connect.reportei.com/api/tools/surveymonkey_create_survey/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"title": "<title>"
}
}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ètre | Type | Obligatoire | Description |
|---|---|---|---|
| title | string | Non | Title of the survey. New Survey when it is left out. |
| nickname | string | Non | Internal name of the survey, shown only to the account. |
| language | string | Non | ISO 639-1 code of the survey language, like en, es or pt. en by default. |
| folder_id | string | Non | Puts the survey in this folder: an id from List survey folders. |
| footer | boolean | Non | false hides the SurveyMonkey footer. |
| buttons_text | object | Non | Texts of the survey buttons. An empty exit_button removes the exit button. |
| custom_variables | object | Non | Custom variables of the survey, the extra values a survey link carries, keyed by variable name. |
| from_survey_id | string | Non | Copies the pages and questions of this survey: an id from List surveys. |
| pages | array | Non | Pages to create with the survey, each with its questions. Leave it out to create an empty survey or a copy. |
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_create_survey. Il devient la définition de tool de votre agent sans conversion.
Autres tools SurveyMonkey
- Lister les enquêtesGETListe les enquêtes que le compte possède ou qui ont été partagées avec lui, avec id, titre et nickname ; include ajoute les compteurs, dates et liens. Paginez avec page tant que la réponse contient links.next.
- Lister les dossiers d'enquêtesGETListe les dossiers d'enquêtes du compte avec id, titre et nombre d'enquêtes. Paginez avec page tant que la réponse contient links.next.
- Obtenir une enquêteGETRenvoie l'enquête entière : réglages, les liens de modification, d'aperçu, de collecte et d'analyse, et chaque page avec ses questions et choix de réponse, tous avec leurs ids. Les outils de réponses et Lister les synthèses de l'enquête se réfèrent à ces ids.
- Mettre à jour une enquêtePATCHModifie le titre, le nickname, la langue, les textes des boutons, les variables personnalisées, le pied de page ou le dossier d'une enquête. Les pages et questions restent inchangées.
- Lister les collecteursGETListe les collecteurs d'une enquête, les moyens par lesquels elle reçoit des réponses, comme un lien web ou une invitation par email, avec id et nom ; include ajoute type, status, url et response_count. Paginez avec page tant que la réponse contient links.next.
- Créer un collecteurPOSTCrée un collecteur pour une enquête. Un collecteur weblink renvoie le lien à partager dans url, et c'est le seul type que le plan gratuit peut créer. Un collecteur email ne fait que préparer l'invitation : destinataires et envoi restent dans SurveyMonkey.
- Mettre à jour un collecteurPATCHModifie un collecteur : le ferme ou le rouvre avec status, ou change son nom, sa date de clôture, sa limite de réponses, ses messages et sa redirection.
- Lister les réponsesGETListe 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.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
