from
et to
paramètres dans aaaa-mm-jj format. Cela permet à un utilisateur d'interroger le système d'analyse pour générer un rapport par jours dans le from
et to
plage de dates. Toute plage de dates spécifiée par l'utilisateur sera interprétée selon le fuseau horaire actuel du compte. Les plages de dates pour la demande sont inclusives, c'est-à-dire exclusives si l'utilisateur fait une demande from=2013-09-24&to=2013-09-27
, la réponse inclura les résultats du 2013-09-24 00:00:00 au 2013-09-27 00:00:00.Paramètres d'URL
Les rapports de l'API Analytics prennent en charge les paramètres d'URL suivants.
Paramètre | Description | Obligatoire | Valeurs | Défaut |
---|---|---|---|---|
account |
Les comptes sur lesquels vous souhaitez créer un rapport | Oui | un ou plusieurs identifiants de compte sous forme de liste délimitée par des virgules | aucun |
dimensions |
La ou les dimensions à signaler | Oui | une ou plusieurs dimensions sous forme de liste délimitée par des virgules (certaines combinaisons ne sont pas valables - utilisez l'outil interactif ici pour déterminer si une combinaison est valable) | aucun |
where |
Utilisé pour spécifier des filtres pour les rapports | non | {dimension}=={valeur} - un ou plusieurs éléments sous forme de liste délimitée par des points-virgules. La valeur sera une ou plusieurs valeurs pour la métrique primaire de cette dimension. Par exemple : video==video_id country=country-code , ou viewer=viewer_id (dans ce dernier cas, la forme du viewer_id varie selon que vous capturez et envoyez vous-même une sorte de viewer_id ou selon la valeur générée par le système d'analyse). |
aucun |
limit |
Nombre d'articles à retourner | non | entier positif | 10 |
offset |
Nombre d'éléments à ignorer | non | entier positif | 0 |
sort |
Champ sur lequel trier les éléments | non | tout champ renvoyé par la requête | Video_View |
fields |
Champs à retourner | non | varie en fonction de la dimension sur laquelle vous créez un rapport | video,video_view |
format |
Format pour renvoyer les résultats dans | non | json (par défaut) | csv | xlxs | json |
reconciled |
Si elle est incluse, elle limitera les résultats aux données historiques ou en temps réel. Les données analytiques proviennent de plusieurs sources : certaines sont envoyées par le lecteur, mais d'autres sont collectées à partir des CDN et du système Video Cloud. Afin de fournir des analyses le plus rapidement possible, nous commençons à fournir des données « en temps réel » dès qu'elles sont disponibles, puis nous ajustons les analyses ultérieurement lorsque les données de toutes les sources ont été collectées et traitées. Les données entièrement traitées sont appelées réconciliées | non | vrai | faux | true |
from |
Le début de la plage de dates de la demande | non |
L'un des éléments suivants :
Seules les dates des 32 derniers jours sont autorisées pour les points finaux d'engagement ou si reconciled=false. |
-30d |
to |
La fin de la plage de dates pour la demande | non |
L'un des éléments suivants :
Seules les dates des 32 derniers jours sont autorisées pour les points finaux d'engagement ou si reconciled=false. |
maintenant |
Champs disponibles
Les champs suivants peuvent être renvoyés pour la dimension.
ad_mode_begin
- le nombre de fois où le joueur est entré en mode publicitéad_mode_complete
- le nombre de fois où le joueur a terminé le mode publicitéactive_media
- le nombre de vidéos actives dans le comptebytes_delivered
- nombre total d'octets délivrés aux machines clientes pour le lecteur et les médias associésdaily_unique_viewers
- utilisateurs uniques quotidiens moyensdate
- la date au format de date ISO 8601 (AAAA-MM-JJ)drm_bytes_packaged
- le nombre d'octets DRM conditionnésengagement_score
- le score d'engagement moyen des vidéoslicenses_served
- le nombre de licences DRM servieslive_seconds_streamed
- le nombre total de secondes de diffusion en direct délivréesplay_request
- nombre total de fois où la lecture vidéo a été demandéeplay_rate
- le taux de lecture moyen (vues vidéo divisées par impressions) pour les vidéosplayer_load
- le nombre total de chargements de joueursvideo_engagement_1
- le nombre total de vues au point de 1% de la durée de la vidéovideo_engagement_100
- le nombre total de vues au point de 100 pour cent de la durée de la vidéovideo_engagement_25
- le nombre total de vues au point de 25% de la durée de la vidéovideo_engagement_50
- le nombre total de vues au point de 50 pour cent de la durée de la vidéovideo_engagement_75
- le nombre total de vues au point de 75 pour cent de la durée de la vidéovideo_impression
- le nombre total de fois où les vidéos ont été chargées dans les lecteursvideo_percent_viewed
- pourcentage total de visionnages pour toutes les vidéos (une somme, pas une moyenne)video_seconds_viewed
- le nombre total de secondes vues pour toutes les vidéosvideo_view
- le nombre total de fois où la lecture vidéo a commencé
Filtrer les valeurs
Utilisée comme filtre, une dimension permet d'affiner les résultats.
Filtrer les valeurs : La dimension de date n'est pas utilisée comme filtre.
Combinaison de dimensions
Pour voir avec quelles dimensions cet élément peut être combiné et quels champs sont disponibles pour la combinaison, voir Dimension et champs.
Exemples de demandes
Demande de dimension
https ://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=date
Demande de filtre
N'est pas applicable
Exemple de réponse
{
"item_count" : 31,
"items" : [
{
"date" : "2022-04-30",
"video_view" : 160
},
{
"date" : "2022-05-07",
"video_view" : 220
},
{
"date" : "2022-05-21",
"video_view" : 226
},
{
"date" : "2022-05-08",
"video_view" : 236
},
{
"date" : "2022-05-28",
"video_view" : 261
},
{
"date" : "2022-05-29",
"video_view" : 280
},
{
"date" : "2022-05-01",
"video_view" : 307
},
{
"date" : "2022-05-03",
"video_view" : 431
},
{
"date" : "2022-05-02",
"video_view" : 512
},
{
"date" : "2022-05-30",
"video_view" : 518
}
],
"summary" : {
"video_view" : 45117
}
}