Obtenir une agrégation avec l'API Fathom Analytics

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

Identifiant
fathom_get_aggregation

L'appel

POST https://connect.reportei.com/api/tools/fathom_get_aggregation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "entity": "pageview",
    "aggregates": "<aggregates>"
  }
}

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
entitystringOuipageview reports on the visits of a site, event on one event.Valeurs : pageview, event
entity_idstringNonWith entity pageview, required: the id of the site, from List sites.
site_idstringNonWith entity event, required: the id of the site, from List sites.
entity_namestringNonWith entity event, required: the name of the event, from List events.
aggregatesstringOuiComma-separated aggregates. For pageview: visits, uniques, pageviews, avg_duration and bounce_rate. For event: conversions, unique_conversions and value, which comes in cents.
date_groupingstringNonGroups the numbers by period. Omit it for totals. hour only works for ranges of up to 7 days.Valeurs : hour, day, month, year
field_groupingstringNonComma-separated fields to group by: hostname, pathname, entry_page, exit_page, referrer_hostname, referrer_pathname, referrer_source, ai_source, browser, country_code, city, state, region, device_type, operating_system, utm_campaign, utm_content, utm_medium, utm_source, utm_term, keyword or ref.
sort_bystringNonA field of aggregates or field_grouping with asc or desc, for example pageviews:desc. With date_grouping, timestamp:asc and timestamp:desc also work.
date_fromstringNonStart as YYYY-MM-DD HH:MM:SS in the timezone of the site, for example 2026-10-01 00:00:00. The default is the first recorded data.
date_tostringNonEnd as YYYY-MM-DD HH:MM:SS in the timezone of the site. The default is now.
limitintegerNonMaximum rows, up to 1000. With field_grouping, the default is 500.
filtersstringNonJSON array of filters, as text. Each filter has property, operator (is, is not, is like, is not like, matching or not matching) and a text value, for example [{"property":"pathname","operator":"is","value":"/pricing"}].

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_get_aggregation. Il devient la définition de tool de votre agent sans conversion.

Autres tools Fathom Analytics

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.