assistance Contacter le support | Étatétat du système du système
Contenu de la page

    API Analytics : Mesures en direct

    Cette rubrique explique les mesures d'analyse disponibles pour les flux en direct.

    Introduction

    Les mesures de lecture pour les flux en direct diffusés par le service Brightcove Live sont disponibles en temps réel, via l' API Analytics. Ces données sont capturées uniquement pour les flux en direct ; la lecture VOD n'est pas incluse.

    L'API fournit des mesures de flux en direct via 2 points de terminaison :

    • /v1/timeseries
    • /v1/events

    Les deux interrogent le même ensemble de données, mais regroupent les résultats différemment. Ce document décrit l'utilisation et la syntaxe de chacun.

    Mesures

    Il s'agit des mesures disponibles via les points de terminaison Live. Les requêtes peuvent demander plusieurs mesures.

    Métrique Description
    alive_ss_ad_start Impressions d'annonces côté serveur
    ccu Sessions uniques ; nombre de distincts (empreinte digitale + session)
    fingerprint_count Appareils uniques ; nombre d' empreintes digitalesdistinctes (voir ci-dessous)
    video_impression Nombre de fois que la vidéo a été chargée dans le lecteur
    video_seconds_viewed Nombre total de secondes observées par tous les téléspectateurs
    video_view Démarrage du flux (pas unique)

    Pour unique suivi, nous attribuons un empreinte digitale à chaque appareil en combinant (Remote IP + User-Agent + Player). Notez que nous n'utilisons pas d'identifiant matériel réel de l'appareil lui-même - cela réduit la précision, mais nous maintient en conformité avec la confidentialité.

    Dimensions :

    Les combinaisons suivantes sont prises en charge en tant que dimensions touches de where filtre :

    • video
    • video, country
    • video, device_type

    Paramètres de requête

    Les deux points de terminaison Live partagent certains paramètres communs qui contrôlent l'étendue et le regroupement de la requête.

    Paramètre Syntaxe Obligatoire Par défaut Description
    dimensions <dim1>,<dim2>,... O - Dimensions de la requête (GROUP BY)
    indicateurs <metric1>,<metric2>,... O - Une ou plusieurs mesures à signaler
    <dim1>=<value1>;... O - Un ou plusieurs filtres de requête ; doit inclure au moins 1 vidéo
    à partir de <epoch> N 32 jours de la valeur « à » La plage de temps commence
    à <epoch> N maintenant Fin de plage de temps

    Série chronologique

    Le /v1/timeseries point de terminaison renvoie une liste de points le long d'une chronologie, avec la valeur de la mesure demandée à chaque moment dans le temps. Les points sont des compartiments de 1 minute par défaut, mais peuvent être modifiés via un paramètre.

    Dans ce contexte, les mesures uniques (ccu, fingerprint_count) indiquent la valeur maximale à tout moment au cours de chaque compartiment. Ainsi, une requête avec bucket_duration=1d retournera la concurrence maximale pour chaque jour, tandis qu'une requête avec bucket_limit=1 retournera la concurrence maximale à tout moment du flux.

    URI

    /v1/timeseries/accounts/$account

    Paramètres supplémentaires

    Paramètre Syntaxe Obligatoire Par défaut Description
    bucket_duration <n>m ( minutes)
    <n>h(heures)
    <n>d(jours)
    N 1m Durée représentée par chaque point. 1d est de 24 heures, pas un jour calendrier.
    bucket_limit <n> N - Nombre de points à retourner. Utilisez bucket_duration ou bucket_limit , mais pas les deux ensemble.

    Réponse

    {
    "<metric1>": {
    "data": [
      {
        "dimensions": {
            "account": "<account>",
            "<dim1>": "<key1>",
            ...
            "<dimN>": "<keyN>"
          },
        "points": [
          {
            "timestamp": <bucket1>,
            "value": <value1>
          },
          ...,
          {
            "timestamp": <bucketN>,
            "value": <valueN>
          },
        ]
      }
    ]
    },
    "<metric2>": {
    ...
    },
    ...
    }
    

    Événements

    Le /v1/events point de terminaison renvoie les totaux de mesure pour tout ou partie d'un flux vidéo en direct.

    Dans ce contexte, les mesures uniques (ccu, fingerprint_count) représentent la valeur totale sur la plage de requête. Par exemple, une requête sans from/to paramètres renverra le nombre total de unique sessions (ccu) et / ou périphériques (fingerprint_count) pour l'ensemble du flux.

    URI

    /v1/events/accounts/$account

    Paramètres supplémentaires

    aucun

    Réponse

    {
    "data": [
    {
      "dimensions": {
        "account": "<account>",
        "<dim1>": "<key1>",
        ...
        "<dimN>": "<keyN>"
      },
      "totals": {
        "<metric1>": <value1>,
        ...
        "<metricN>": <valueN>
      }
    }
    ]
    }
    

    Exporter

    Le point de terminaison Events fournit également un rapport téléchargeable :

    /v1/events/accounts/$account/videos/$video/export?format=xlsx

    La réponse est un fichier XLSX avec des mesures Live sur 4 Sheets :

    • Résumé
    • Utilisateurs simultanés
    • Vues par type de périphérique
    • Vues par géographie

    Exemples d'utilisation

    Pour tous ces exemples, nous utiliserons Compte 1234, Vidéo 5555, et supposons une heure actuelle de 12:00:00 UTC le 15 février 2020.


    Obtenir le nombre de visionneuses (CCU) actuel pour un flux en direct ou une chaîne

    Définissez à partir d'au moins 2 minutes (11:58 AM), et utilisez le dernier point dans la réponse.

    /v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581767880000


    Obtenir des points graphiques CCU pour un flux en direct au cours des dernières 24 heures

    Zoom avant (points d'une minute)

    /v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1m

    Zoom arrière (points d'une heure)

    /v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1h


    Obtenez la CCU maximale par jour pour une chaîne en direct au cours des 7 derniers jours

    /v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581206400000&bucket_duration=7d


    Obtenez la CCU maximale à tout moment au cours d'une diffusion en direct

    /v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&bucket_limit=1


    Obtenez le total des visionneuses uniques et des secondes vues pour plusieurs diffusions en direct

    La vidéo 5555 est terminée ; les chiffres sont définitifs. La vidéo 5556 est toujours active ; les chiffres sont en cours d'exécution.

    /v1/events/accounts/1234?dimensions=video&metrics=fingerprint_count,video_seconds_viewed&where=video==5555,5556


    Obtenir les totaux de l'auditoire et de la publicité pour une émission d'une heure sur une chaîne en direct <

    ÉMISSION DIFFUSÉE DE 10H À 11:00 (UTC)

    /v1/events/accounts/1234?dimensions=video&metrics=alive_ss_ad_start,video_view,fingerprint_count&where=video==5555&from=1581760800000&to=1581764399999


    Obtenir l'auditoire par pays pendant la durée d'un flux en direct

    /v1/events/accounts/1234?dimensions=video,country&metrics=video_view,fingerprint_count&where=video==5555