Service Indicateurs - Spécifications et utilisation
Spécifications
Le service indicateur vous permet d'obtenir la configuration des différents indicateurs que vous pouvez interroger via le service de consultation des données. Ces informations sont aussi disponibles sous forme de documentation dans la section liste des indicateurs. Le service propose 2 méthodes différentes :
- Liste : fournit la liste des indicateurs accessibles pour un compte. Ainsi vous ne risquez pas d'interroger le service de consultation des données avec un indicateur qui n'est pas disponible
- Détail : fournit le détail d'un indicateur en particulier. Cette méthode ne prend pas un compte les restrictions liées aux comptes
Schémas
Le schéma utilisé pour les requêtes est disponible à l'adresse suivante : ind-request.xsd
Le schéma utilisé pour les réponses est disponible à l'adresse suivante : ind-response.xsd
Le schéma utilisé pour les réponses par catégorie est disponible à l'adresse suivante : ind-cat-response.xsd
Description des paramètres
Liste des indicateurs / Liste des indicateurs par catégorie
| Code | Format | Obligatoire | Description |
|---|---|---|---|
| tokenId | Chaine de caractères | Oui | Jeton qui identifie l'utilisateur connecté au web service. Expire au bout de 6h d'inactivité |
| serial | Chaine de caractères | Oui | Serial (identifiant du compte client) utilisé pour filtrer les indicateurs disponibles |
| fullDesc | Booléen | Non | Indique si la réponse doit faire apparaître la description complète des indicateurs ou seulement leur nom et code. Dans le cas d'une description complète, les informations fournies pour chaque indicateur sont les mêmes que celles renvoyées par la méthode de détail |
Détail d'un indicateur
| Code | Format | Obligatoire | Description |
|---|---|---|---|
| tokenId | Chaine de caractères | Oui | Jeton qui identifie l'utilisateur connecté au web service. Expire au bout de 6h d'inactivité |
| code | Chaine de caractères | Oui | Code de l'indicateur demandé. Les informations détaillées de l'indicateur correspondant à ce code seront renvoyées |
Pour des exemples de requêtes détaillant l'utilisation de ces différents paramètres, merci de consulter la section Exemples de requêtes.
Réponses du service indicateurs
Un exemple de réponse du service indicateur est présent ci-dessous. Certains éléments ont été omis pour plus de clarté. Le format de réponse est le même entre le service liste et le service détail, seul le nombre d'indicateurs renvoyés change.
<indicatorResponse tokenId="xxxxxxxxxxxxxxxxxxxx"> <universe> <code>STREAMING</code> <indicator> <code>STREAMING_ANALYSE_FLUX</code> <name>Streaming+analyse+des+flux</name> <periods> <period>D</period> </periods> <labels> <label> <code>STREAMING_NIVEAU1</code> <name>Niveau+1</name> <filters> <filter> <code>EQUALS</code> </filter> ... plus de filtres </filters> <type>STRING</type> </label> </labels> <units> <unit> <code>CONNEXIONS</code> <name>Connexions</name> <type>NUMBER</type> <periods> <period>W</period> <period>T</period> <period>M</period> <period>D</period> <period>D_AVG</period> </periods> </unit> ... plus d'unités </units> </indicator> ... plus d'indicateurs </universe> ... plus d'univers </indicatorResponse>
Le service indicateur par catégorie renvoie un format de réponse spécifique. Un exemple de réponse est présent ci-dessous. Certains éléments ont été omis pour plus de clarté.
<indicatorCategoryResponse tokenId="16511bca9f05747d289ba1bdd132a0271dc84cc621d144501c7b91e11a2a177a">
<universe>
<code>STREAMING</code>
<category>
<code>STREAMING_SYNTHESE</code>
<name>Synth%C3%A8se+de+l%27activit%C3%A9</name>
<indicator>
<code>STREAMING_SYNTHESE</code>
<name>Synth%C3%A8se+des+lectures</name>
</indicator>
<indicator>
<code>STREAMING_SYNTHESE_TERMINAL</code>
<name>Streaming+rapport+par+terminal</name>
</indicator>
... plus d'indicateurs
</category>
<category>
<code>STREAMING_ANALYSE_FLUX</code>
<name>Analyse+des+flux</name>
<subCategory>
<code>STREAMING_NIVEAUX_DEDUPS</code>
<name>Niveaux+d%C3%A9dupliqu%C3%A9s</name>
<indicator>
<code>STREAMING_NIVEAU1</code>
<name>Streaming+par+niveau+1</name>
</indicator>
</subCategory>
... plus de sous-catégories
</category>
... plus de catégories
</universe>
</indicatorCategoryResponse>
Univers
L'élément universe représente un univers de mesure (STREAMING, PODCAST etc) dans lequel sont regroupés des indicateurs. Cet élément indique le code de l'univers et contient les indicateurs qui lui sont rattachés.
Catégorie
L'élément category représente une catégorie d'un univers dans laquelle sont regroupées des indicateurs. Cet élément indique le code de la catégorie et contient les indicateurs qui lui sont rattachés. Une catégorie peut contenir des sous-catégorie via l'élément subCategory.
Indicateur
Chaque élément indicateur (indicator) contient le détail des informations permettant de l'interroger. Son code et son nom (code et name) permettent d'identifier l'indicateur. L'élément periods contient la liste des périodes (period) : ce sont les types de périodes utilisables pour cet indicateur. L'élément labels contient les différents libellés associés à l'indicateur. Ce sont les éléments label que vous retrouverez dans la réponse du service de consultation des données. Pour chaque libellé, les filtres applicables sont indiqués par les éléments filters et filter : le code d'un filtre correspond au type à utiliser dans une requête du service de consultation des données. L'élément units détaille la liste des unités (unit) avec pour chacune leur nom et leur code (name et code). L'élément periods liste les périodes pour lesquelles l'unité sera disponible lors d'une utilisation en période libre.
Cas d'erreur
Explications
Dans le cas d'une requête invalide, une réponse d'erreur contenant un code et un message est renvoyée. Pour plus d'information sur les codes d'erreur et leur signification, merci de consulter la liste des erreurs.
Exemple de réponse d'erreur
<indicatorResponse> <errorCode>102</errorCode> <errorMessage>Missing+parameter+%3A+serial</errorMessage> </indicatorResponse>