Service Complétion

Introduction

Le service complétion vous permet d'analyse pour un flux ou un groupe de flux le nombre d'utilisateurs en fonction de la quantité de flux qu'ils ont consommé. La durée d'un flux étant décomposée en pourcentage, le service vous indique, le nombre d'utilisateurs qui ont consommé une quantité donnée du contenu. Vous obtenez ainsi le nombre d'utilisateurs ayant consommé en tout 1% du contenu, 2% du contenu, etc.

Le service complétion est accessible à l'une des 2 adresses suivantes selon le format de réponse choisi :

https://ws.estat.com/gosu/rest/streaming/completion/xml
https://ws.estat.com/gosu/rest/streaming/completion/json

Schémas

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

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

Exemples de requêtes GET

GET
https://ws.estat.com/gosu/rest/streaming/completion/xml?tokenId=cc9ffdfe3a7b2b41263ca5cb5d11403e04d588a978fdbabaf629257abc3c07e3&serial=254054201858&startDate=2012-01-23&endDate=2012-01-23&level1=chauffard&level2=A10

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 requête
startDate
endDate		 Date format ISO 8601 : YYYY-MM-DD Oui Date de début et de fin de la période analysée. La période ne doit pas excéder 14 jours
level1
level2
level3
level4
level5
stream
genre
domain		 Chaine de caractères Oui Eléments de filtrage sur un flux. Au moins un des paramètres doit être renseigné.

Réponses du service complétion

Un exemple de réponse du service complétion est présent ci-dessous.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<streamAnalysisCompletionResponse
	tokenId="c0c015394be5db47041c771e25e2be966f60a9cac4fc43fa910b3812ef856693">
	<serial>254054201858</serial>
	<startDate>2012-01-23</startDate>
	<endDate>2012-01-23</endDate>
	<streamFilter>
		<level1>chauffard</level1>
		<level2>A10</level2>
	</streamFilter>
	<streamCount>1</streamCount>
	<labels>
		<label code="QUANTITE_FLUX" name="Quantité de flux" pos="1" />
	</labels>
	<units>
		<unit code="UTILISATEURS" name="Utilisateurs" pos="2" />
	</units>
	<data>
		<row>
			<col>1</col>
			<col>0</col>
		</row>
		<row>
			<col>2</col>
			<col>0</col>
		</row>
		... plus de lignes
	</data>
</streamAnalysisCompletionResponse>

Rappel des paramètres

Les éléments serial, startDate, endDate et streamFilter sont un rappel des paramètres utilisés pour la requête.

Nombre de flux aggrégés

Le champ streamCount indique le nombre de flux distincts qui ont été aggrégés. Si plusieurs flux sont aggrégés, cela signifie que les filtres utilisés (streamFilter) ne sont pas assez discriminants. Vous pouvez aggréger des flux qui correspondent au même contenu. Dans le cas contraire l'aggrégation se fait sur un découpage des contenus en pourcentage alors que la durée de ces contenus peut être totalement différente. Nous déconseillons ce type d'analyse sur un regroupement de flux qui ne correspondent pas à des contenus identiques. Un cas correct d'aggrégation correspond par exemple à un même contenu diffusé sur plusieurs domaines : dans ce cas les flux correspondent bien au même contenu.

Libellés, unités et tableau de résultat

Les éléments labels, units et data sont semblables à ceux du service de consultation des données. Référez vous à la description de ces éléments.

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

<streamAnalysisCompletionResponse>
	<errorCode>102</errorCode>
	<errorMessage>Missing+parameter+%3A+startDate</errorMessage>
</streamAnalysisCompletionResponse>