Référence des outils

Disponible avectoutes les offres

Quand vous connectez un client IA à Cabin, il a accès aux outils ci-dessous. Votre assistant choisit lesquels appeler en fonction de ce que vous demandez. Les outils sont regroupés selon ce qu'ils font :

• Les outils de lecture se contentent de récupérer des données et peuvent être lancés à tout moment sans risque.
• Les outils d'écriture créent ou modifient des éléments : la plupart des clients vous demandent d'abord confirmation.
• Les outils destructifs suppriment des données : les clients vous demandent toujours confirmation avant de les lancer.

Chaque outil agit uniquement sur les domaines de votre propre compte et respecte votre offre. Un outil qui a besoin d'une fonctionnalité que vous n'avez pas vous le signale, au lieu de renvoyer des données partielles.

Outils de lecture

list_domains

Liste tous les domaines de votre compte, chacun avec l'URL de son tableau de bord privé (et celle du tableau de bord public si le partage est activé). Aucun paramètre.

get_analytics

Les statistiques d'un domaine sur une période : pages vues, visiteurs uniques, sessions, pages les plus vues et référents.

• domain : le domaine à interroger (par exemple example.com)
• date_from, date_to : la période, au format YYYY-MM-DD
• scope : ce qu'il faut inclure : core, pages, referrals, ou une combinaison (par défaut core)
• limit_lists : nombre d'éléments renvoyés dans chaque liste (par défaut 50)

get_domain_settings

Les paramètres actuels de l'un de vos domaines : fuseau horaire, état du tableau de bord public, destinataires du rapport hebdomadaire, hôte personnalisé du script, couleur de la marque et liste des adresses IP exclues. Lisez-les avant de modifier emailRecipients ou excludeIps, car ces deux paramètres remplacent toute la liste.

• domain : le domaine à lire

validate_installation

Vérifie que le script de suivi Cabin est correctement installé sur l'un de vos domaines.

• domain : le domaine à vérifier

check_custom_domain_dns

Vérifie que le CNAME d'un sous-domaine personnalisé pointe bien vers custom.withcabin.com.

• custom : le sous-domaine personnalisé à vérifier (par exemple stats.example.com)

analyse_page

Lance une analyse carbone/énergie et performance sur une seule URL, avec les moyennes historiques. Pour une URL que Cabin n'a jamais vue, comptez 20 à 30 secondes.

• url : l'URL complète à analyser (par exemple https://example.com/about)
• force : relancer l'analyse même s'il en existe une récente (par défaut false)

Outils d'écriture

create_domain

Ajoute un nouveau domaine à votre compte. Renvoie l'URL du tableau de bord et l'extrait de code du script de suivi à installer.

• domain : le domaine à ajouter (sans protocole ni chemin)
• tz : fuseau horaire IANA des statistiques, par exemple Europe/London (par défaut UTC)

update_domain_settings

Modifie un ou plusieurs paramètres d'un domaine qui vous appartient.

• domain : le domaine à modifier
• public : rendre le tableau de bord accessible publiquement
• publicPassword : protéger le tableau de bord public par un mot de passe ; une chaîne vide le retire (Plus et Scale)
• privacypage : afficher un engagement de confidentialité sur le tableau de bord public
• emailRecipients : tableau des adresses e-mail qui reçoivent le rapport hebdomadaire de ce domaine (Plus n'envoie qu'à l'adresse e-mail de votre compte, Scale à n'importe qui). Remplace la liste entière : pour ajouter ou retirer une adresse, lisez d'abord les destinataires actuels avec list_domains, puis envoyez la liste complète mise à jour. Un tableau vide arrête tous les e-mails hebdomadaires.
• tz : fuseau horaire IANA
• color : couleur de la marque du tableau de bord (hexadécimal)
• excludeIps : tableau de 30 adresses IP ou plages CIDR maximum (IPv4 ou IPv6) dont les visites sont écartées dès la réception. Remplace toute la liste ; passez [] pour la vider. Définir ou lire cette liste via un client IA transmet ces adresses au fournisseur de ce client.

add_custom_domain

Associe un sous-domaine personnalisé pour que le script de suivi soit servi depuis votre propre hôte et contourne les bloqueurs de publicités. Renvoie les instructions de configuration DNS et la nouvelle balise <script> à installer une fois le DNS vérifié (Plus et Scale).

• domain : le domaine Cabin vers lequel le sous-domaine pointera
• custom : le sous-domaine à utiliser, par exemple stats.example.com (évitez les noms comme analytics, tracker ou stats, que les bloqueurs de publicités ciblent eux-mêmes)

Outils destructifs

delete_domain

Supprime définitivement un domaine de votre compte ; la suppression de ses statistiques est alors programmée. Cette action est irréversible.

• domain : le domaine à supprimer

remove_custom_domain

Détache un sous-domaine personnalisé d'un domaine qui vous appartient, et renvoie la balise script de l'hôte par défaut à remettre sur votre site.

• domain : le domaine Cabin auquel le sous-domaine est rattaché
• custom : le sous-domaine à retirer