Nombre d'éléments (GetRowCount)
Avant ou après la visualisation de votre extrait de résultats, il est possible de connaître le nombre de lignes de votre requête en cliquant sur le bouton d’actualisation « - Lignes » situé sous le jeu de données. Une fois le nombre de lignes actualisé, l’icône se grise automatiquement.
Vous pouvez également obtenir l’URL REST de la requête permettant de connaître le nombre de lignes (paramètre GetRowCount) en cliquant sur l’icône.
Formats de structure
Vous pouvez obtenir un aperçu de la structure de vos résultats en cliquant sur l’icône « Structure » située à droite de l’URL. Vous pouvez afficher les 3 formats de sortie proposés: JSON, HTML ou XML.
Astuce
Il ne s’agit que d’un aperçu. Pour sélectionner le format souhaité, vous devez cliquer sur ce dernier directement dans la barre de « Génération d’URL ».Possibilités d'export - API
Data Query permet d'exporter vos données sous plusieurs formats, en fonction de vos besoins. Ce choix de format vous permet d'utiliser l'API pour importer des données dans vos outils, et/ou pour retraiter les données obtenues.
Formats
Pour importer vos données dans un outil tiers, vous pouvez exporter vos données via l'API, sous 3 formats différents:
- HTML
- XML
- JSON
Vous pouvez ainsi importer les données souhaitées, au format désiré, dans de nombreux outils tiers. Le choix du format de sortie s’effectue en sélectionnant le format dans la barre située au-dessus de l'URL :
Cette URL est mise à jour dès que vous modifiez votre template. Vous pouvez l’exploiter facilement en cliquant sur l’icône « Tout sélectionner ». Dès que la chaîne est sélectionnée, il suffit ensuite d’effectuer un copier/coller là où vous en avez besoin (dans votre navigateur, par exemple).
Astuce
Vous pouvez modifier le format, directement dans votre appel API : https://apirest.atinternet-solutions.com/data/v2/xml/getData?&space={s:XXXXX}&period={R:{D:'-1'}}&max-results=20&page-num=1
Limites
* Nombre d’appels API
Les appels à l’API REST peuvent être faits de manière illimitée, il n’y a pas de limitation en quantité d’appels sur une période. Cependant le nombre d’appels en simultané est lui bridé par utilisateur, afin de garantir une prestation de service constante.
Chaque utilisateur de l’interface se voit attribuer une série de créneaux afin d’appeler l’API. Un créneau est utilisé le temps que l’appel API soit traité par AT Internet et les données renvoyées à l’utilisateur.
Lorsque un utilisateur utilise 5 créneaux en simultané, il recevra, au 6eme appel, le message d’erreur suivant : « Fréquence d’appels autorisés dépassée » (code 5001) ». L’utilisateur devra attendre qu’un de ses créneaux se libère pour pouvoir appeler à nouveau l’API d’AT Internet.
* Nombre de lignes de résultats par appel API
Vous pouvez extraire jusqu’à 10 000 lignes par appel API (formats JSON et XML). Pour extraire la totalité du jeu de donnée de votre analyse, vous devez utiliser la fonctionnalité de pagination vous permettant d’extraire les données par paquets de 10 000 lignes à la fois.
Shortcodes
Le shortcode est une URL courte et unique ; ainsi toute modification effectuée dans l’un de vos templates est automatiquement appliquée dans le shortcode associé. Il est donc vivement conseillé d’utiliser la fonctionnalité de ShortCode si vous souhaitez intégrer des données via notre API dans des outils tiers, ou si vous avez construit des tableaux Excel avec les IQY. De ce fait, vous pourrez éditer votre template, le modifier, sans avoir à changer les URLs que vous avez automatisé avec votre équipe technique.
Astuce
Pour obtenir le shortcode, vous devez au préalable enregistrer votre template. Il est également possible de surcharger le short si nécessaire, voir plus d’informations à ce sujet dans la rubrique « API ».
Paramètres obligatoires et facultatifs
Pour récupérer les données de votre analyse en cours de construction, vous devez avoir configuré automatiquement :
- Le ou les sites sur lequel(s) porte votre analyse
- Avoir au moins 1 métrique dans votre analyse
- Avoir configuré au moins 1 période dans votre analyse.
Si vous ne modifiez la configuration par défaut vous aurez :
- Le nombre de ligne de votre analyse limité à 20
- Le format de votre appel API en JSON
- La date fixée sur la journée de la veille
> Vous pouvez visualiser l’ensemble des paramètres API obligatoires et facultatifs dans la rubrique API.
Possibilités d'exports - Pop-up d'export
Si vous souhaitez retraiter vos données (dans un fichier Excel par exemple), vous pouvez exporter vos résultats et vos templates en cliquant sur le bouton « Exporter ».
Deux formats sont disponibles : CSV et IQY.
Vous pouvez ensuite donner un nom à votre fichier et choisir le séparateur décimal de votre choix (point ou virgule).
CSV
Le format CSV est un format standard pour l’échange de données.
Par défaut, le nom du fichier est celui du template. Si vous n'avez pas enregistré votre template, le nom par défaut est mycsv. Avant d'exporter un fichier, il vous faudra renseigner le séparateur souhaité ainsi que le nombre d'éléments à retourner.
IQY
Le format IQY est un format spécifique à Microsoft. Il permet de créer des interconnexions entre notre API et votre tableur Excel. Construisez ainsi des tableaux de bord dynamiques, pour lesquels vous pourrez actualiser les données directement depuis Excel sans aucune manipulation technique de votre part.
Avant d'exporter un fichier, il vous faudra renseigner le séparateur souhaité ainsi que le nombre d'éléments à retourner. Vous devrez également préciser les paramètres que vous souhaitez dynamiser. La dynamisation des paramètres vous permettra de modifier la valeur directement dans votre fichier Excel.
Astuce
Vous pouvez également dynamiser d'autres paramètres de votre IQY, en l'ouvrant via votre éditeur de code. Il sera alors nécessaire de remplacer la valeur du paramètre par '["Texte","Texte à afficher dans la pop in d'Excel"]'. Par exemple avec cet IQY, il faut dynamiser la période à sélectionner : https://apirest.atinternet-solutions.com/v2/html/getData?&columns={d_time_date,m_visits}&sort={-m_visits}&space={s:XXXXXX}&period={D:{start:'["Debut","Veuillez saisir une date de debut au format AAAA-MM-JJ"]',end:'["Fin","Veuillez saisir une date de fin au format AAAA-MM-JJ"]'}}&page-num=1&sep=comma&max-results=20
Paramétrages
Pour exporter vos données en fonction du format souhaité, il vous sera nécessaire de :
- Renseigner la période par défaut du template (celle-ci pourra-être dynamisée grâce à l'IQY)
- Renseigner au moins une dimension et une métrique
Par défaut le nombre de réponses par page est 20. Vous pouvez configurer jusqu'à 1000 lignes dans l'interface et 100 000 lignes pour un csv. L'élément page vous permet d'indiquer les éléments que vous souhaitez obtenir. Par exemple, pour un appel renvoyant 60 lignes, sachant qu’il y a 20 lignes par page, alors vous obtiendrez les lignes 21 à 40 lorsque vous sélectionnerez la page 2.