L’API publique donne un accès en lecture aux données d’un projet. Elle sert à alimenter un tableau de bord interne, un rapport automatique ou un outil tiers.

Authentification

Créez une clé dans Paramètres → Clés API → Clés API publiques, puis envoyez-la en Bearer :
Cette clé donne accès à vos statistiques. Gardez-la côté serveur : ne l’intégrez jamais dans un site ou une application mobile.
Une clé est rattachée à un projet. Les statistiques portent sur l’environnement Production s’il est actif, sinon sur le Bac à sable. Il n’est pas encore possible de choisir l’environnement.

Format des réponses

meta.rate_limit.reset est un timestamp Unix. meta.bot_filter indique si le trafic des robots connus est exclu. Les erreurs suivent le format décrit dans l’introduction.

Paramètres de période

/stats et /pages acceptent : La période est limitée à 366 jours. Une période invalide renvoie 400.

Endpoints

GET /v1/public/account

Le compte propriétaire du projet.
subscription_status vaut "none" pour le plan Starter, "active" sinon.

GET /v1/public/account/usage

La consommation du mois en cours.

GET /v1/public/sites

La liste des sites accessibles avec la clé. Elle contient un seul élément : le projet de la clé.

GET /v1/public/sites/{site_id}

Un site. Renvoie 404 si site_id n’est pas le projet de la clé.

GET /v1/public/sites/{site_id}/stats

Les indicateurs principaux sur la période. Les robots connus sont exclus.

GET /v1/public/sites/{site_id}/pages

Les pages du site sur la période. Paramètre supplémentaire : limit, de 1 à 500, 100 par défaut.
Les champs de cet endpoint sont en camelCase, contrairement aux autres. Malgré meta.bot_filter: true, le trafic des robots n’y est pas encore exclu.