Créer un collecteur avec l'API SurveyMonkey

Cré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.

Identifiant
surveymonkey_create_collector

L'appel

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

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.
typestringOuiweblink gives a link to share, returned in url. email needs a paid plan, and its invitations are sent from SurveyMonkey.Valeurs : weblink, email
namestringOuiName of the collector, shown only to the account.
thank_you_pageobjectNonCustom thank-you page shown after a response.
redirect_typestringNonEnd 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.Valeurs : url, close, loop
redirect_urlstringNonURL the respondent goes to after finishing.
close_datestringNonWhen the collector stops accepting responses, as an ISO 8601 date and time.
closed_page_messagestringNonMessage shown when the collector is closed.
response_limitintegerNonCloses the collector after this many responses.
allow_multiple_responsesbooleanNonLets the same browser answer more than once. Not for email collectors.
anonymous_typestringNonTurns off IP tracking; in an email collector, fully_anonymous also drops the email and name of the respondent.Valeurs : not_anonymous, partially_anonymous, fully_anonymous
edit_response_typestringNonWhen a respondent can still change the answers.Valeurs : until_complete, never, always
display_survey_resultsbooleanNonShows the current results to the respondent at the end.
passwordstringNonPassword the respondent must type to open the survey.
disqualification_messagestringNonMessage for a respondent who is disqualified by the survey logic.
disqualification_urlstringNonURL a disqualified respondent goes to.

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