Référence des outils

Le serveur met à disposition les outils ci-dessous. Chaque outil nécessite le scope OAuth précisé : une connexion disposant seulement de scorecards:read ne peut pas appeler d’outil nécessitant scorecards:write.

Les outils destructifs écrasent ou suppriment des données existantes. La majorité des clients demandent une confirmation explicite avant leur exécution.

scorecard_design_guide

À consulter avant de créer ou modifier une scorecard. Ce guide traite des questions de cadrage, de la conception des questions, de la valeur des paliers et du choix des thèmes.

Scope : scorecards:read · idempotent

Argument	Type	Requis	Description
topics	tableau de chaînes	non	Sections ciblées à retourner (ex. “themes”, “questions”). Par défaut toutes.

list_scorecards

Liste les scorecards du compte avec leur slug, statut de publication, nombre de soumissions et règles d’intégration.

Scope : scorecards:read · idempotent

Argument	Type	Requis	Description
status	all | published | draft	non	Filtrer par statut de publication. Par défaut all.

get_scorecard

Consulte une scorecard dans son intégralité : configuration, dimensions, questions, réponses et paliers.

Scope : scorecards:read · idempotent

Argument	Type	Requis	Description
slug	chaîne	oui	Le slug de la scorecard.

create_scorecard

Crée un nouveau brouillon avec paramètres visuels, marque, paliers globaux, intégration et capture d’e-mails.

Scope : scorecards:write

Argument	Type	Requis	Description
title	chaîne	oui	Titre affiché aux répondants.
subtitle	chaîne	non	Sous-titre précisant la cible et la durée.
slug	chaîne	non	Slug unique d’URL. Dérivé du titre si omis.
idempotencyKey	chaîne	non	Clé d’idempotence évitant les doublons en cas de nouvelle tentative.
ctaText	chaîne	non	Texte du bouton initial.
version	chaîne	non	Numéro de version interne (ex. “1.0”).
theme	default | playground | obsidian | brutalist	non	Thème visuel.
overallTierStrategy	weakest | average	non	Règle de calcul du résultat global : weakest (palier le plus faible) ou average (moyenne).
tiers	tableau d’objets	non	Paliers globaux de résultats.
emailCaptureBeforeQuestions	booléen	non	Collecte de l’e-mail avant (true) plutôt qu’après (false) les questions.
privacyPolicyUrl	chaîne ou null	non	Lien vers la politique de confidentialité.
termsUrl	chaîne ou null	non	Lien vers les conditions d’utilisation.
embed	objet	non	Paramètres d’intégration iframe.
branding	objet	non	Palette, logo et boutons d’action.
emailCapture	objet	non	Configuration de l’écran de collecte des contacts.
detail	summary | full	non	Niveau de détail retourné (summary par défaut).

update_scorecard_config

Met à jour la configuration générale d’une scorecard sans altérer ses dimensions, questions ou réponses.

Scope : scorecards:write · destructif

Argument	Type	Requis	Description
slug	chaîne	oui	Slug actuel de la scorecard.
newSlug	chaîne	non	Nouveau slug (aucune redirection n’est mise en place).
title	chaîne	non	Nouveau titre.
subtitle	chaîne	non	Nouveau sous-titre.
ctaText	chaîne	non	Nouveau texte du bouton d’action.
version	chaîne	non	Nouvelle version interne.
theme	default | playground | obsidian | brutalist	non	Nouveau thème visuel.
overallTierStrategy	weakest | average	non	Nouvelle stratégie de calcul global.
tiers	tableau d’objets	non	Nouveaux paliers globaux.
emailCaptureBeforeQuestions	booléen	non	Moment de capture de l’e-mail.
privacyPolicyUrl	chaîne ou null	non	Nouvelle URL de confidentialité.
termsUrl	chaîne ou null	non	Nouvelle URL de conditions.
embed	objet	non	Nouveaux réglages d’intégration.
branding	objet	non	Nouvelle palette de marque.
emailCapture	objet	non	Réglages du formulaire de contact.
detail	summary | full	non	Niveau de détail retourné.

add_dimension

Ajoute un axe d’évaluation à une scorecard.

Scope : scorecards:write

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
label	chaîne	oui	Nom de la dimension.
shortLabel	chaîne	non	Libellé court pour les graphiques.
key	chaîne	non	Clé stable de la dimension.
detail	summary | full	non	Niveau de détail retourné.

add_questions

Ajoute l’intégralité des questions d’une dimension en une seule requête. Les options doivent être ordonnées de la moins bonne à la meilleure avec leurs scores.

Scope : scorecards:write

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
dimensionKey	chaîne	oui	Clé de la dimension concernée.
questions	tableau d’objets	oui	Questions ordonnées (3 à 5 recommandées).
detail	summary | full	non	Niveau de détail retourné.

add_question

Ajoute une question unique à une dimension existante.

Scope : scorecards:write

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
dimensionKey	chaîne	oui	Clé de la dimension.
text	chaîne	oui	Énoncé de la question.
answers	tableau d’objets	non	Réponses scorées.
detail	summary | full	non	Niveau de détail retourné.

set_dimension_tiers

Définit les paliers de résultats (titre et analyse) d’une dimension, du plus faible au plus élevé. Les seuils de points sont calculés automatiquement.

Scope : scorecards:write · destructif, idempotent

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
dimensionKey	chaîne	oui	Clé de la dimension.
tiers	tableau d’objets	oui	Paliers ordonnés (généralement trois).
detail	summary | full	non	Niveau de détail retourné.

update_dimension

Modifie le libellé, le nom court, le poids ou la position d’une dimension. La clé reste inchangée.

Scope : scorecards:write · destructif, idempotent

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
dimensionKey	chaîne	oui	Clé de la dimension à modifier.
label	chaîne	non	Nouveau libellé.
shortLabel	chaîne	non	Nouveau libellé court.
weight	entier	non	Pondération dans le résultat global.
position	entier	non	Nouvelle position d’affichage (index 0).
detail	summary | full	non	Niveau de détail retourné.

update_question

Modifie l’énoncé, les choix de réponses ou la position d’une question. Les soumissions antérieures conservent leur état historique.

Scope : scorecards:write · destructif, idempotent

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
questionId	chaîne	oui	Identifiant unique de la question.
text	chaîne	non	Nouvel énoncé.
answers	tableau d’objets	non	Nouvelles options de réponses.
position	entier	non	Nouvelle position au sein de la dimension.
detail	summary | full	non	Niveau de détail retourné.

remove_question

Supprime une question d’une dimension. Les plages des paliers sont recalculées en conséquence.

Scope : scorecards:write · destructif

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
questionId	chaîne	oui	Identifiant de la question à effacer.
detail	summary | full	non	Niveau de détail retourné.

remove_dimension

Supprime une dimension ainsi que toutes les questions associées.

Scope : scorecards:write · destructif

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
dimensionKey	chaîne	oui	Clé de la dimension à supprimer.
detail	summary | full	non	Niveau de détail retourné.

check_scorecard

Vérifie l’aptitude d’une scorecard à la publication et met en évidence ses manques éventuels.

Scope : scorecards:read · idempotent

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.

publish_scorecard

Publie une scorecard ou la repasse au statut de brouillon.

Scope : scorecards:write · destructif, idempotent

Argument	Type	Requis	Description
slug	chaîne	oui	Slug de la scorecard.
published	booléen	non	true pour publier, false pour brouillon.
detail	summary | full	non	Niveau de détail retourné.

list_submissions

Consulte les soumissions reçues avec filtrage par scorecard, état de complétion, palier ou date.

Scope : scorecards:read · idempotent

Argument	Type	Requis	Description
slug	chaîne	non	Limiter à une scorecard spécifique.
status	all | completed | partial	non	Soumissions complètes ou partielles.
tier	chaîne	non	Filtrer par palier global obtenu.
dimension	chaîne	non	Filtrer par dimension la plus faible.
since	chaîne	non	À partir du (AAAA-MM-JJ).
until	chaîne	non	Jusqu’au (AAAA-MM-JJ).
search	chaîne	non	Recherche textuelle sur nom, e-mail ou entreprise.
limit	entier	non	Nombre de lignes à retourner (défaut : 25).

get_submission

Récupère l’intégralité d’une soumission : contact, résultat global, scores par axe et réponses précises enregistrées.

Scope : scorecards:read · idempotent

Argument	Type	Requis	Description
submissionId	chaîne	oui	Identifiant unique de la soumission.