Un appel API requiert que certaines conditions soient remplies afin de pouvoir retourner des données, sans quoi il ne marchera pas et tombera en erreur, dont la liste est disponible sur la documentation de l'API. Il faut donc vérifier plusieurs points.
Notez que, de manière générale, nous conseillons de préparer votre requête sur Data Query, puis de copier l'appel API automatiquement généré :
Limites de l'API
L'API de Reporting présente plusieurs limites, à savoir :
- paramètre
columns: vous pouvez obtenir jusqu’à 50 éléments différents (propriétés + métriques) dans ce paramètre - paramètre
max-results: vous pouvez renvoyer jusqu’à 10 000 lignes par appel API (200 000 lignes maximum) - paramètre
page-num: vous pouvez définir la page que vous souhaitez récupérer. La valeur maximale de ce paramètre dépend demax-results(200,000 lignes maximum) - Vous pouvez utiliser jusqu’à 6 segments distincts dans votre requête (en incluant les segments utilisés dans les métriques)
L'API Key
Il faudra vous assurer que l'API Key que vous utilisez existe, et qu'elle ait été créée sur un compte qui dispose des droits d'accès nécessaire pour exécuter l'appel API en question.
En effet, un API Key hérite des droits d'accès du compte sur lequel elle a été créée. Si le compte en question n'a pas accès au site que vous tentez de requêter, la clé API utilisée ne vous permettra pas d'avoir un résultat. Il faudra soit créer une API Key sur un autre compte, soit mettre à jour les droits d'accès du compte initial.
De plus il est important de noter que pour utiliser votre API Key il vous sera souvent demandé de la formater dans un type précis pour qu'elle soit reconnue comme moyen d'authentification. Nous vous conseillons ainsi de la sauvegarder en délimitant l'access et la secret par un tiret du bas (acceskey_secretkey).
L'espace (ou site)
Si vous copiez / collez les exemples de la documentation de l'API sans mettre à jour les paramètres, ou si vous ne recopiez pas correctement l'ID du site à requêter, vous aurez une erreur d'appel.
Il faudra vous assurer que l'ID du site en question soit le bon, et qu'il soit renseigné au bon format.
Appels simultanés
L'API est limitée en termes d'appels concurrents à :
- 20 appels API concurrents par organisation
- 5 appels API concurrents par utilisateur
Si vous rencontrez une erreur en lien avec le nombre d'appels simultanés, il sera nécessaire de relancer votre appel dans quelques instants.
Propriétés et métriques
Vous devrez également vérifier que les propriétés et métriques contenues dans l'appel existent. Pour cela, rendez-vous sur Data Query et ajoutez les propriétés et/ou métriques à votre requête, et observez le contenu de l'appel API.
Pour les propriétés, vous pouvez également retrouver leur property key dans votre Data Model.