Service de consultation des données - Spécifications et utilisation

Spécifications

Le service de consultation des données vous permet de consulter les différents indicateurs calculés par Médiamétrie-eStat. Le service propose les fonctionnalités suivantes :

La liste des indicateurs et le paramétrage associé sont disponibles dans la section liste des indicateurs. Vous pouvez ainsi prendre connaissance des différents indicateurs et de leurs spécificités.

Pour une intégration automatisée et dynamique de la liste des indicateurs disponibles pour vos différents comptes nous vous conseillons d'utiliser le service indicateurs.

Schémas

Le schéma utilisé pour les requêtes est disponible à l'adresse suivante : gosu-request.xsd

Le schéma utilisé pour les réponses est disponible à l'adresse suivante : gosu-response.xsd

Description des paramètres

  • 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 la récupération des données
    date Date format ISO 8601 : YYYY-MM-DD Oui Date utilisée pour la récupération des données
    indicator Chaine de caractères Oui Code de l'indicateur utilisé pour la récupération des données. Se reporter à la liste des indicateurs disponibles.
    page Entier Non Numéro de page sélectionné. Valeur par défaut : 1
    pageSize Entier Non Taille de page sélectionnée. Valeur par défaut : 50. Valeur maximum autorisée : 1000
    unit Chaine de caractères Non Code de l'unité (de l'indicateur sélectionné) utilisée pour trier les résultats
    order Chaine de caractères Non Ordre du tri appliqué sur les résultats. Ne peut être utilisé sans le paramètre " unit". Valeurs possibles : "asc", "desc". Valeur par défaut : desc
    value Entier Non Limite du nombre de résultats sélectionnés lors d'un tri. Ne peut être utilisé sans le paramètre "unit". Valeur par défaut : aucune limite
    filterLabel Chaine de caractères Non Label (de l'indicateur sélectionné) utilisé pour filtrer les résultats
    filterType Chaine de caractères Non Type de filtre appliqué sur le label
    filterValue Chaine de caractères Non Chaine de caractères utilisée pour filtrer les résultats
    periodType Chaine de caractères Non Type de période utilisée pour la sélection des résultats : Jour(D), Semaine(W), Mois(M)
    masterMode Chaine de caractères Non Mode de sélection des comptes de cumul : cumulé(ACCUMULATED) ou ventilé(VENTILATED)
    multiSerialMode Chaine de caractères Non Mode de sélection pour une requête multi serials : TOTAL (somme de tous les comptes. Valeur par défaut si non spécifié) ou DETAIL (résultats de chaque compte).
    groupingLabels Objet Non Liste des labels utilisés pour regroupement des résultats. Cette valeur n'est disponible qu'en mode de requête POST.
    Exemple, pour regrouper les résultats par valeurs des labels STREAMING_NIVEAU3 et STREAMING_NIVEAU4, ajouter dans la requête 
    "groupingLabels": {
  "label:" [
    { "code": "STREAMING_NIVEAU3", "pos": 1},
    { "code": "STREAMING_NIVEAU4", "pos": 2}
  ]
}

    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 de données

    Un exemple de réponse du service de consultation des données est présent ci-dessous. Certains éléments ont été omis pour plus de clarté.

    <gosuResponse tokenId="a8e959ec9d33af7626f8de176cd0568931efada0ef7066e2c6884f1f6e4f39ec">
	<page>1</page>
	<pageSize>50</pageSize>
	<nbLinesTotal>2252</nbLinesTotal>
	<serial>254054201858</serial>
	<date>2012-01-18</date>
	<periodType>D</periodType>
	<labels>
		<label code="STREAMING_NIVEAU1" name="Niveau+1" pos="1"/>
	</labels>
	<filters>
		<filter label="STREAMING_NIVEAU1" type="EQUALS" value="Luc"/>
	</filters>
	<units>
		<unit code="LECTURES" name="Sessions" pos="2"/>
		<unit code="LECTEURS_QUOTIDIENS" name="Utilisateurs+quotidiens" pos="3"/>
		<unit code="DUREE_TOTALE" name="Dur%C3%A9e+totale+des+sessions" pos="4"/>
	</units>
	<data>
		<row>
			<col>rtl+jazz+festival</col>
			<col>2</col>
			<col>1</col>
			<col>350</col>
		</row>
		<row>
			<col>Vendredi+22+juillet</col>
			<col>2</col>
			<col>2</col>
			<col>536</col>
		</row>
		...
	</data>
</gosuResponse>

    Page

    Le champ page indique la page de résultats renvoyées.

    Taille de page

    Le champ pageSize indique la taille de page renvoyée.

    Nombre total de lignes

    Le champ nbLinesTotal indique le nombre total de lignes de résultat correspondant à la requête envoyée. Ce nombre permet de calculer le nombre de pages de résultats disponibles en fonction de la taille de page souhaitée.

    Compte

    Le champ serial indique l'identifiant du compte utilisé pour la requête.

    Dates

    Les champ date, startDate et endDate indiquent les dates utilisées pour la requête.

    Type de période/ventilation

    Le champ periodType représente le type de période demandé (jour, semaine, mois) lorsqu'une seule date est utilisée ou le type de ventilation (jour, semaine, mois, total) lorsqu'une période libre est utilisée.

    Type de paramètre Date Type de période/ventilation
    D W M T D_AVG
    Période simple : une seule date, paramètre date Pas de restriction. Un seul jour est renvoyé La date doit correspondre à un lundi. Le total d'une semaine est renvoyé La date doit correspondre à un premier du mois. Le total d'un mois est renvoyé Même comportement que D Même comportement que D
    Période libre : date de début et date de fin, paramètres startDate et endDate Pas de restriction. Le détail jour à jour est renvoyé La date de début doit correspondre à un lundi et la date de fin à un dimanche ou à la veille. La veille permet de gérer les demandes sur la semaine en cours. Le détail semaine par semaine est renvoyé La date de début doit correspondre à un premier du mois et la date de fin à un dernier du mois ou la veille. La veille permet de gérer les demandes sur le mois en cours. Le détail mois par mois est renvoyé Pas de restriction. Le total pour toute la période est renvoyé Pas de restriction. La moyenne par jour de toute la période est renvoyée

    Libelles

    Le champ labels contient les différents éléments label qui représentent les libellés de l'indicateur qui sont utilisés dans le tableau de résultats. L'attribut position indique l'indice de la colonne dans le tableau de résultats.

    Filtres

    Le champ filters contient les différents éléments filter qui représentent les filtres utilisés pour la requête.

    Unités

    Le champ units contient les différents éléments unit qui représentent les unités de l'indicateur qui sont utilisés dans le tableau de résultats. L'attribut position indique l'indice de la colonne dans le tableau de résultats.

    Tableau de résultats

    Le champ data contient le tableau de résultat qui se décompose en différentes lignes contenus dans les éléments row. Chaque ligne contient plusieurs colonnes avec les éléments col.

    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

    <gosuResponse>
	<errorCode>102</errorCode>
	<errorMessage>Missing+parameter+%3A+serial</errorMessage>
</gosuResponse>