Les avantages pour vous
Avec Showpad Analytics API, vous êtes en mesure de générer et télécharger tout ce que vous voyez dans la section des rapports de Showpad Online Platform. Quand une ressource a-t-elle été vue, combien de temps l'a-t-elle été ? Qui a partagé quelle ressource et avec qui ?
L'API d'analyse de Showpad vous permettra de télécharger les données brutes sous forme de fichier CSV ou JSON. Vous pourrez ainsi les utiliser dans votre propre solution de BI, les combiner avec d'autres sources de données de votre organisation et y exécuter une analyse personnalisée. L'API d'analyse respecte également l'anonymisation des noms d'utilisateur et des identifiants. Vous pouvez toujours joindre des tableaux pour analyser les données.
Il peut y avoir une différence entre les données renvoyées par l'exportation API et les analyses de Showpad Online Platform. Le fichier CSV renvoyé par l'API est plus granulaire et vous fournit toutes les données brutes. Les données totalisées de notre Online Platform pour le total des vues et le contenu le plus élevé peuvent diverger des données brutes API exportées. Ceci est expliqué en détail ci-dessous.
Découvrir
Utilisez le point de terminaison Événements pour renvoyer les données de partage que vous devez associer à d'autres points de terminaison d'exportation.
Principales caractéristiques
- Téléchargez des données granulaires au format CSV et JSON.
- Importez les données dans vos outils personnalisés une fois exportées.
- Personnalisez la limite maximale de réponses retournées.
- Seul GET est possible pour recevoir des données d'analyse.
- Si activé, nous respectons l'anonymisation des noms d'utilisateur et des identifiants dans les résultats.
Ce qu'il vous faut pour réussir
- Plan tarifaire Ultime de Showpad
- Accès à Showpad Online Platform
- Connaissance des API
- Showpad API Explorer, les clients REST et les lignes de commande ne sont pas un mystère pour vous.
- Veuillez noter que les données d'exportation brutes peuvent différer des données totalisées de notre Online Platform pour les totaux d'affichage et le contenu le plus haut.
Contrôlez les éléments renvoyés avec l'en-tête X-Showpad-Scroll-Id.
- Par défaut, le nombre maximal d'éléments renvoyés dans le point de terminaison de l'API d'événements est défini à 500. Vous pouvez modifier la limite et définir une plage comprise entre 50 et 1000 réponses. La réponse viendra avec un en-tête appelé X-Showpad-Scroll-Id qui contient un jeton. Si vous faites à nouveau la même demande mais définissez cet en-tête selon votre demande, vous obtiendrez le deuxième lot d'événements. Vous récupérez un autre X-Showpad-Scroll-Id que vous pouvez utiliser pour récupérer le troisième lot d'événements, etc. De cette façon, vous pouvez créer une boucle dans l'application jusqu'à ce qu'ils aient récupéré tous les événements souhaités. Lorsqu'aucun événement ne revient dans la réponse, cela indique la fin. Il y a des millions d'événements dans la base de données et il n'est pas possible de tout renvoyer en une fois. Vous pouvez donc faire défiler l'écran jusqu'à ce que tous les événements dont vous avez besoin soient affichés.
- Les résultats de l'exportation d'événements de l'API sont limités et vous devrez utiliser l'en-tête X-Showpad-Scroll-Id pour continuer à recevoir des données.
- L'en-tête X-Showpad-Scroll-Id n'est pas modifié à chaque appel / réponse. Il reste valide pour une durée x, utilisez donc toujours l'en-tête X-Showpad-scroll-id de la réponse pour la requête suivante.
L'en-tête donne à l'API une référence qui passe l'appel et renverra le prochain lot de rapports. C'est comparable avec une clé d'authentification.
Faits importants sur les données retournées.
- Lors de l'examen des données de vues, il est possible que les nombres de la section des rapports de notre Online Platform et ceux de l'exportation API soient différents. Si un client potentiel clique et affiche le contenu d'un partage et quitte l'ordinateur, Showpad continue de compter les heures d'ouverture du contenu. Dans Showpad Online Platform, ces données sont totalisées et limitées à une heure. Cependant, dans les données brutes, nous comptons jusqu'à huit heures.
- Dans le rapport Online Platform du Contenu le plus élevé, les partages sont calculés en tant que nombre de fois qu'une partie de contenu est partagée avec quelqu'un. Un document partagé avec deux personnes en même temps comptera pour deux partages. Si vous consultez le rapport Contenu le plus élevé il indiquera, par exemple, 100 partages. Cela montre quels utilisateurs de l' application ont partagé le contenu. Donc 100 représente 100 utilisateurs différents. Dans l'exportation de l'API, les données granulaires seront affichées. Par conséquent, si vous les ajoutez correctement, vous obtenez les mêmes numéros.
- Pour exporter les données au format CSV, il vous suffit de changer l'extension JSON à CSV dans votre commande curl. Cela renverra un fichier CSV que vous pourrez utiliser dans vos outils personnalisés.
Découvrez comment cela fonctionne dans l'API Explorer de Showpad
- Vous pouvez accéder à notre API Explorer via Online Platform: Paramètres - intégrations - API.
Pour accéder directement à API Explorer, accédez à https: // {votresousdomaine}.Showpad.biz / devportal / explorer. - Basculez vers API v3 pour utiliser API Analytics.
- Ouvrez API Explorer et ouvrez Exports.
- Vous pouvez voir tous les points de terminaison Export disponibles. Celles-ci vous donneront toutes les données brutes sur les actifs, les divisions, les chaînes,...
- Pour la partie analytique, le point de terminaison Événements est le plus important. Ce noeud final contient toutes les données de partages et indique, par exemple, quel identifiant d'utilisateur a partagé quoi, avec quel identifiant de contact.
Plus d'informations sur les événements d'exportation (/API/v3/exports/events.JSON)
Application ouverte
Un utilisateur commercial a ouvert l' application Showpad.
Actif dans l'application visualisé
La ressource a été visualisée par un utilisateur commercial / administrateur dans l'application Showpad.
Actif partagé vu
Un client potentiel a regardé un actif dans un partage.
Partage des actifs
Un utilisateur commercial a partagé un actif avec un client potentiel.
Actif partagé téléchargé
Un client potentiel télécharge un actif qui a été partagé avec lui.
Partage vu
Un partage a été vu par un client potentiel.
Partage créé
Un partage a été envoyé par un utilisateur commercial.
Courriel de partage ouvert
Un client potentiel a ouvert le courriel qui inclut un partage.
- Utilisez ces données pour créer des relations avec les autres points de terminaison d'exportation.
