Lister les collecteurs avec l'API SurveyMonkey

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

Identifiant
surveymonkey_list_collectors

L'appel

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

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.
namestringNonOnly the collectors whose name matches this text.
start_datestringNonOnly collectors created after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
end_datestringNonOnly collectors created before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset.
includestringNonExtra fields, separated by commas: type, status, response_count, date_created, date_modified and url.
sort_bystringNonField the collectors are sorted by.Valeurs : id, date_modified, type, status, name
sort_orderstringNonAscending or descending order.Valeurs : ASC, DESC
pageintegerNonPage of results, starting at 1.
per_pageintegerNonResults per page, up to 1000.

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