L’API de statistiques Digiteka vous permet d’importer directement dans vos outils de dataviz les données statistiques liées à votre activité vidéo.
La première étape pour l’utilisation de cette API de statistiques est de gérer la connexion en utilisant les identifiants qui vous ont été communiqués par notre équipe Médias.
curl https://ws.digiteka.com/api/auth/login -k -H "Content-Type: application/json" -d '{"email": "email@example.com", "password": "MotDePasse"}'
La réponse est au format suivant :
{"token_type":"Bearer","access_token":"xxxxx","expires_at":"yyyyy","refresh_token":"zzzzz"}
La récupération des données s’effectue en requêtant notre API à l’aide des paramètres suivants :
startDate et endDate
Vous permet de définir précisément la période d’analyse en définissant une date de début et une date de fin de la période au format AAAA-MM-JJ
data
Vous permet de définir les données que vous souhaitez récupérer via l’API. Si plusieurs données vous intéressent, elles doivent être séparées par une virgule.
Voici la liste exhaustive des données qu’il est possible de récupérer via l’API :
taux_de_declenchement
inventory_player
inventory_player_hors_adb
taux_de_adblock
displays
appels_aux_tag_pub
impressions_pub
taux_de_remplissage_hab
revenus
cpm_moyen
visibilite_pub
completion_pub_25_per
completion_pub_50_per
completion_pub_75_per
completion_pub_100_per
complete_visibles
taux_de_click
skips_pub
streams
completion_video_25_per
completion_video_50_per
completion_video_75_per
completion_video_100_per
video_duration
percent_completed
owner_number_published_videos
dimensions
Vous permet d’ajouter une ou plusieurs dimensions à votre analyse si vous souhaitez par exemple mettre en avant une répartition dans les données.
Si plusieurs dimensions vous intéressent, elles doivent être séparées par une virgule.
Voici la liste exhaustive des dimensions qu’il est possible de récupérer via l’API :
adblock
country
device
os
navigator
siteName
zoneName
siteCompanyName (subcontext editor uniquement)
labelCompanyName (subcontext owner uniquement)
typePlayer
videoTopicName
ownerName
videoDuration
regieName
video (ID de la vidéo)
videoTitle (Titre de la vidéo)
videoCreationTime
position
cspa1 (pour le consentement)
filters
Vous permet d’altérer la valeur des données en fonction d’un ou plusieurs filtres qui sont listés ci-dessous.
Si plusieurs filtres vous intéressent, ils doivent être séparés par une virgule.
Voici la liste exhaustive des filtres qu’il est possible d'utiliser sur l’API :
mdtkZone_xxxxxxxx_y (xxxxxxxx = mdtk, y = zone, par exemple mdtkZone_01234567_1)
typePlayer_x (x = 1 pour simple player, x = 0 pour smart player)
videoTopic_x (x = id de catégorie de la video, par exemple x = 21 pour News)
position_x (x = preroll / preroll2 / postroll / overlay)
os_x (x = Windows / Android / iOS / Mac_OS_X / Others)
device_x (x = 0 pour desktop, 1 pour mobile, 2 pour tablette)
navigator_x (x = Chrome / Chrome_Mobile / Firefox / Mobile_Safari / Facebook / Chrome_Mobile_WebView / Safari / Edge / Samsung_Internet / Mobile_Safari_UI!WKWebView / Google / IE / Others)
adblock_x (x = 0 pour sans adblock, x = 1 pour avec adblock)
videoDuration_x (x = 1 pour durée entre 0 et 15 secondes, x = 2 pour durée entre 16 et 30 secondes, x = 3 pour durée entre 31 et 45 secondes, x = 4 pour durée entre 46 et 60 secondes, x = 5 pour durée supérieure à 60 secondes)
country_xx (xx = code ISO alpha-2 du pays)
granularity
Vous permet d’ajouter une dimension temporelle à votre analyse. Les valeurs possibles sont les suivantes :
none
day
month
year
context
Vous permet de sélectionner l'environnement de Player sur lequel vous souhaitez baser votre analyse :
instream
subcontext
Vous permet de sélectionner de sélectionner la vision que vous souhaitez pour votre analyse :
editor
owner
tout
Exemple de requête à l'API
curl https://ws.digiteka.com/api/studio/generate -k -H "Content-Type: application/json" -H "authorization: Bearer xxxxx" -d '{"ranges":[{"startDate":"2021-11-17","endDate":"2021-11-17","period":"P"},null],"data":["impressions_pub","streams"],"dimensions":["device","typePlayer"],"filters":["adblock_0","country_FR"],"granularity":"day","context":"instream","subcontext":"editor"}'
Exemple de réponse associée
{"dimensions":[{"id":"device","category_id":"2","label":"device"},{"id":"typePlayer","category_id":"3","label":"type-de-player"},{"id":"day","category_id":"1","label":"jour"}],"columns":[{"id":"impressions_pub","category_id":"2","label":"impressions-pub"},{"id":"streams","category_id":"4","label":"streams"}],"body":[{"headers":["Desktop","Smart","2021-11-16"],"body":[[82458,155884]]},{"headers":["Desktop","Smart","2021-11-17"],"body":[[81923,148687]]},{"headers":["Desktop","Smart","2021-11-15"],"body":[[59749,121381]]},{"headers":["Mobile","Simple","2021-11-16"],"body":[[35221,81080]]},{"headers":["Mobile","Simple","2021-11-17"],"body":[[20279,40502]]},{"headers":["Mobile","Simple","2021-11-15"],"body":[[20162,40039]]},{"headers":["Mobile","Smart","2021-11-17"],"body":[[10985,20566]]},{"headers":["Mobile","Smart","2021-11-16"],"body":[[11303,16938]]},{"headers":["Mobile","Smart","2021-11-15"],"body":[[8761,13868]]},{"headers":["Tablet","Simple","2021-11-16"],"body":[[1278,3653]]},{"headers":["Desktop","Simple","2021-11-16"],"body":[[1812,3213]]},{"headers":["Desktop","Simple","2021-11-15"],"body":[[1432,2593]]},{"headers":["Tablet","Simple","2021-11-17"],"body":[[791,2030]]},{"headers":["Tablet","Simple","2021-11-15"],"body":[[724,1846]]},{"headers":["Tablet","Smart","2021-11-17"],"body":[[445,1172]]},{"headers":["Desktop","Simple","2021-11-17"],"body":[[666,1115]]},{"headers":["Tablet","Smart","2021-11-16"],"body":[[447,949]]},{"headers":["Tablet","Smart","2021-11-15"],"body":[[374,938]]}],"totals":[338810,656454]}