L'API ouverte Analytics vous permet d'exporter les données des rapports Agorapulse vers des plateformes externes.
En utilisant l'API ouverte, vous pouvez rationaliser vos flux de travail et créer des rapports personnalisés dans vos outils d'analyse, de visualisation de données ou de veille stratégique (BI) préférés en dehors d'Agorapulse.
Dans cet article, nous aborderons les points suivants :
Remarque : L’API ouverte est disponible pour les utilisateurs disposant d’un abonnement Custom. Si vous souhaitez modifier votre abonnement pour accéder à cette fonctionnalité, n’hésitez pas à nous contacter à l’adresse ici.
Comment générer une clé API
Avant de pouvoir effectuer des opérations de récupération de données ou d'autres actions via notre API ouverte, vous devrez d'abord générer une clé API. Pour ce faire :
Cliquez sur l'avatar en bas à gauche de l'écran.
Sélectionnez Paramètres personnels
Cliquez sur Clés API
En haut à droite de l'écran, cliquez sur Générer une nouvelle clé API
Ajoutez un nom pour la clé et cliquez sur Créer
Une fois la clé générée, cliquez sur le bouton Copier
Nous n'afficherons plus votre code API secret après sa génération.Après avoir copié votre clé API, cliquez sur Terminé.
Remarque : La clé API est unique à chaque utilisateur et les autorisations accordées pour les API dépendent des niveaux d’accès qui vous sont attribués. Pour pouvoir demander des données pour tous les profils sociaux connectés, il est recommandé d’utiliser la clé API du propriétaire ou du gestionnaire de l’organisation ayant accès à tous les profils sociaux.
Comment obtenir les identifiants requis
Pour pouvoir effectuer des actions via l'API ouverte, vous aurez besoin des trois identifiants suivants :
Identifiant Organisation
ID de l'espace de travail
ID de profil
Remarque : Pour récupérer ces identifiants, vous devrez utiliser notre documentation API : https://api.agorapulse.com/docs
Comment récupérer votre identifiant d'organisation
Vous aurez d'abord besoin de l'identifiant de votre organisation. Vous pouvez l'obtenir en procédant comme suit :
Ouvrir notre documentation API
Sous Authentification, vous devrez coller votre clé API et cliquer sur Définir
Cliquez ensuite sur Obtenir les organisations de gestionnaires dans le menu de gauche de la page.
Cliquez sur le bouton Essayer
Dans la zone Réponse, vous verrez la liste de toutes les organisations dont vous êtes membre, ainsi que leurs identifiants.
Comment récupérer votre identifiant d'espace de travail
Après avoir copié l'ID de l'organisation que vous souhaitez utiliser, vous devrez récupérer l'ID de l'espace de travail. Pour se faire :
Faites défiler vers le bas jusqu'à la section Espace de travail, ou cliquez sur Obtenir les espaces de travail de l'organisation dans le menu de gauche de la page.
Collez votre ID d'organisation
Cliquez sur le bouton Essayer
Dans la zone Réponse, vous verrez la liste de tous vos espaces de travail au sein de votre organisation, ainsi que l'ID de l'espace de travail.
Comment récupérer votre identifiant de profil
Le dernier identifiant dont vous aurez besoin est celui du profil social à partir duquel vous allez demander des données. Vous pouvez procéder comme suit :
Faites défiler vers le bas jusqu'à la section Profil, ou cliquez sur Obtenir les profils d'espace de travail dans le menu de gauche de la page.
Collez votre ID d'organisation et ID d'espace de travail dans les champs appropriés.
Cliquez sur le bouton Essayer
Dans la zone Réponse, vous verrez une liste de tous les profils sociaux ajoutés à l'espace de travail de votre organisation, ainsi que l'ID du profil.
Comment demander des données analytiques à partir de l'API ouverte
Grâce à votre clé API, votre espace de travail, votre organisation et votre profil, vous pouvez désormais générer des données de reporting à partir de l'API ouverte pour vos rapports Audience, Contenu (Performance) et Community Management. Les données analytiques sont disponibles pour :
Facebook
Instagram
LinkedIn
YouTube
TikTok
Pour demander des données analytiques à l'API, vous devrez :
Dans la documentation de l'API Ouvrir la documentation de l'API sous Rapport dans le menu de gauche, sélectionnez le type de rapport :
Audience
Community Management
Contenu
Sous le type de rapport sélectionné, vous devrez saisir les éléments suivants sous Paramètres de chemin :
Identifiant Organisation
ID de l'espace de travail
ID de profil
Ensuite, sous Paramètres de chaîne de requête, vous devrez remplir les champs suivants pour définir la période de rapport au format d'horodatage*.
Depuis
Jusqu'à
Enfin, cliquez sur Essayer, récupérer vos données analytiques.
* Remarque : Vous pouvez convertir les dates de votre période de reporting en horodatage à l’aide d’un outil de conversion comme celui ci-dessous.
Informations importantes
Il y a une limite de 500 requêtes par période de 30 minutes.
Il s'agit d'un accès en lecture seule : vous ne pourrez rien modifier ni interagir avec les données via l'API.
Les rapports personnalisés et les rapports sur le retour sur investissement des médias sociaux ne font pas partie de l'API.
Les données d'écoute ne sont pas incluses dans l'API.