Cette API permet d'extraire des Raw Data, c'est-à-dire des données brutes (par opposition aux données cumulées) soit au niveau de la page, soit au niveau de la session. Les tâches d'exportation peuvent être créées, exécutées et téléchargées par le biais d'un programme à l'aide de cette API de données brutes, ou bien manuellement avec la fonctionnalité d'exportation des Raw Data.
Si vous souhaitez retrouver les données cumulées des modules d'analyse de Contentsquare, utilisez les Métriques d'API.
Étape 1 : Créer une key API au niveau du projet
Suivez ces instructions pour créer une key API au niveau du projet.
Étape 2 : Consulter l'API
Une fois la key API et les exports de données qu'il est intéressant pour vous d'avoir régulièrement créés, vous devrez retrouver les données via l'API.
Pour une documentation détaillée sur le fonctionnement de l'API et la manière de le consulter, référez-vous à notre documentation sur l'API Raw Data (disponible en anglais).
FAQ
Combien de keys API peuvent être générées par projet ?
10 keys. Elles doivent être générées au niveau du projet.
Les consultations de l'API sont-elles prises en compte dans ma limite de requêtes mensuelle ?
Non. Les consultations des points d'extrémité de l'API de données brutes ne contribuent pas à votre limite mensuelle de requêtes pour l'API ouverte (cette limite ne peut être atteinte que par des requêtes sur les points d'extrémité des métriques d'API).
Que se passe-t-il si mon export ne se télécharge pas comme prévu ?
Les erreurs qui peuvent se produire avec l'API de données brutes n'apparaissent pas clairement dans l'interface utilisateur. Si les fichiers attendus ne sont pas disponibles dans votre interface d'exportation, cela signifie qu'une erreur s'est produite et que vous devez réessayer. Pour vérifier les erreurs, vous pouvez consulter la liste des travaux de l'API : les travaux qui ont échoué auront le statu "ÉCHEC".