Rechercher des réponses avec l'API Typeform
Recherche les réponses d'un formulaire par valeurs de réponse, tags, hidden fields, métadonnées ou heure de soumission, toutes les conditions ensemble. À préférer à List responses pour filtrer par une réponse. Pour la page suivante, passez le response_id du dernier élément en before_response_id.
- Identifiant
- typeform_search_responses
L'appel
POST https://connect.reportei.com/api/tools/typeform_search_responses/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"form_id": "<form_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ètre | Type | Obligatoire | Description |
|---|---|---|---|
| form_id | string | Oui | Id of the form, from List forms or from the form URL: u6nXL7 in https://mysite.typeform.com/to/u6nXL7. |
| filter_group | object | Non | Conditions that must all match. |
| response_type | array | Non | Response states to return, completed by default. |
| size | integer | Non | Responses per page, 25 by default and up to 1000. |
| sort | array | Non | Sort clauses as field,direction: a field id from Get form or submitted_at, staged_at or landed_at, then asc or desc. Cannot be combined with the cursors. |
| before_response_id | string | Non | Pagination cursor: a response_id from Search responses, for the responses submitted before it. |
| after_response_id | string | Non | Pagination cursor: a response_id from Search responses, for the responses submitted after it. |
| query | string | Non | Only responses whose answers, hidden fields or variables contain this exact phrase. |
| fields | array | Non | Field ids from Get form to keep in the answers. The other answers come back as null. |
| answered_fields | array | Non | Field ids from Get form: only responses that answered at least one of them. |
Connexions possibles
Votre client connecte son compte Typeform une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/typeform, 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/typeform_search_responses. Il devient la définition de tool de votre agent sans conversion.
Autres tools Typeform
- Lister les workspacesGETListe les workspaces accessibles au compte, dans toutes ses organisations, avec id, name, self.href et le nombre de formulaires. Paginez avec page jusqu'à atteindre le page_count de la réponse.
- Créer un workspacePOSTCrée un workspace dans l'organisation dont l'utilisateur connecté est propriétaire et le renvoie avec id et self.href.
- Lister les formulairesGETListe les formulaires du compte, publics et privés, avec id, titre, dates et le lien public dans _links.display. Paginez avec page jusqu'à atteindre le page_count de la réponse.
- Consulter un formulaireGETRenvoie la définition complète d'un formulaire : paramètres, thème, workspace, hidden fields, écrans, logique et les champs avec leurs ids et refs. Les ids des champs sont ce sur quoi filtrent les outils de réponses.
- Créer un formulairePOSTCrée un formulaire dans un workspace et le renvoie avec id, ids des champs et le lien public dans _links.display. Les images des champs et des écrans doivent déjà exister dans le compte.
- Mettre à jour un formulairePUTRemplace la définition complète d'un formulaire. Lisez-le avec Get form, modifiez ce qu'il faut et renvoyez tout : chaque champ garde son id, et un champ omis est supprimé avec ses réponses dans les réponses existantes.
- Lister les réponsesGETListe les réponses d'un formulaire, de la plus récente à la plus ancienne, avec answers, hidden fields, variables, métadonnées et les heures landed_at et submitted_at. Les réponses des 30 dernières minutes peuvent manquer. Le corps contient total_items ; pour la page suivante, passez le response_id du dernier élément en before.
- Lister les thèmesGETListe les thèmes du compte, du plus récent au plus ancien, avec id, nom, couleurs et police. Paginez avec page jusqu'à atteindre le page_count de la réponse.
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.
