Lister les sites avec l'API Fathom Analytics
Liste les sites du compte avec id, name, sharing et timezone, du plus ancien au plus récent. L'id est le code du script de suivi que demandent les autres outils. Tant que has_more est true, envoyez l'id du dernier site comme starting_after.
- Identifiant
- fathom_list_sites
L'appel
POST https://connect.reportei.com/api/tools/fathom_list_sites/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"limit": 1
}
}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 |
|---|---|---|---|
| limit | integer | Non | Sites per page, up to 100. The default is 10. |
| starting_after | string | Non | Cursor: the id of the last site of the previous page. |
| ending_before | string | Non | Cursor that pages backwards: the id of the first site of the current page. |
Connexions possibles
Votre client connecte son compte Fathom Analytics 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.
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/fathom_list_sites. Il devient la définition de tool de votre agent sans conversion.
Autres tools Fathom Analytics
- Obtenir un siteGETRenvoie un site avec son nom, sharing, fuseau horaire et date de création.
- Créer un sitePOSTCrée un site et le renvoie avec l'id à mettre dans le script de suivi. Nécessite un jeton avec la permission Admin.
- Mettre à jour un sitePOSTModifie un site. Seuls les champs envoyés changent.
- Lister les événementsGETListe tous les noms d'événements que le site a suivis, avec leur devise, triés par nom. Les rapports sur un événement utilisent son nom ; l'id ne sert que de curseur de page. Tant que has_more est true, envoyez l'id du dernier événement comme starting_after.
- Obtenir une agrégationGETConstruit un rapport personnalisé sur les pages vues d'un site ou sur un événement : totaux, ou regroupés par période et par champs comme pathname, referrer_source ou utm_campaign. Les nombres reviennent sous forme de texte et il n'y a pas de pagination : les rapports regroupés renvoient jusqu'à 500 lignes, sauf si limit indique autre chose.
- Obtenir les visiteurs actuelsGETRenvoie combien de personnes sont sur le site en ce moment. Avec detailed, aussi les 150 pages et les 150 sources principales.
- Lister les jalonsGETListe les jalons du site, les dates marquées sur ses rapports, du plus ancien au plus récent. Tant que has_more est true, envoyez l'id du dernier jalon comme starting_after.
- Créer un jalonPOSTMarque une date sur les rapports du site, comme le lancement d'une campagne.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
