Einführung
Wiedergabe-Metriken für Live-Streams, die vom Brightcove Live-Dienst bereitgestellt werden, sind in Echtzeit über die Analytics-APIverfügbar. Diese Daten werden nur für Live-Streams erfasst; die VOD-Wiedergabe ist nicht enthalten.
Die API bietet Live-Stream-Metriken über 2 Endpunkte:
/v1/timeseries
/v1/events
Beide fragen denselben Datensatz ab, aggregieren die Ergebnisse jedoch unterschiedlich. Dieses Dokument beschreibt die Verwendung und Syntax der einzelnen.
Kennzahlen
Dies sind die Metriken, die über die Live-Endpunkte verfügbar sind. Abfragen können mehrere Metriken anfordern.
Metric | Beschreibung |
---|---|
alive_ss_ad_start |
Serverseitige Anzeigenimpressionen |
ccu |
Einzigartige Sitzungen; Anzahl der Distinct (Fingerabdruck + Session) |
fingerprint_count |
Einzigartige Geräte; Anzahl der unterschiedlichen Fingerabdrücke(siehe unten) |
video_impression |
Anzahl der Ladezeiten von Videos in den Player |
video_seconds_viewed |
Sekundenschnelle, die von allen Zuschauern angesehen werden |
video_view |
Stream startet (nicht eindeutig) |
Für ein einzigartiges Tracking weisen wir jedem Gerät einen Fingerabdruck zu, indem wir (Remote IP
+ User-Agent
+ Player
kombinieren. Beachten Sie, dass wir keine tatsächliche Hardware-ID vom Gerät selbst verwenden - dies reduziert die Genauigkeit, hält uns jedoch datenschutzkonform.
Abmessungen:
Die folgenden Kombinationen werden als dimensions
und where
Filterschlüssel unterstützt:
video
video, country
video, device_type
Abfrageparameter
Beide Live-Endpunkte haben einige gemeinsame Parameter, die den Umfang und die Gruppierung der Abfrage steuern.
Parameter | Syntax | Erforderlich | Default | Beschreibung |
---|---|---|---|---|
Abmessungen | <dim1>,<dim2>,... |
J | - | Abmessungen abfragen (GROUP BY) |
Metriken | <metric1>,<metric2>,... |
J | - | Eine oder mehrere Metriken, die gemeldet werden sollen |
Dabei gilt: | <dim1>=<value1>;... |
J | - | Ein oder mehrere Abfragefilter; muss mindestens ein Video enthalten |
von | <epoch> |
N | 32 Tage von „bis“ Wert | Zeitbereich beginnt |
bis | <epoch> |
N | jetzt | Ende des Zeitbereichs |
Time Serie
Der /v1/timeseries
Endpunkt gibt eine Liste von Punkten entlang einer Zeitleiste mit dem Wert der angeforderten Metrik zu jedem Zeitpunkt zurück. Punkte sind standardmäßig 1-Minuten-Buckets , können aber über einen Parameter geändert werden.
In diesem Zusammenhang geben Eindeutige Metriken (ccu
, fingerprint_count
) den maximalen Wert zu jeder Zeit während jedes Buckets an. Eine Abfrage mit bucket_duration=1d
gibt also die maximale Parallelität für jeden Tag zurück, während eine Abfrage mit bucket_limit=1
zu jedem Zeitpunkt im Stream die maximale Parallelität zurückgibt.
URI
/v1/timeseries/accounts/$account
Weitere Parameter
Parameter | Syntax | Erforderlich | Default | Beschreibung |
---|---|---|---|---|
bucket_dauer | <n>m ( Minuten)<n>h (Stunden)<n>d (Tage) |
N | 1m | Dauer wird durch jeden Punkt dargestellt. 1d ist 24 Stunden, kein Kalendertag. |
bucket_limit | <n> |
N | - | Anzahl der zurückzugebenden Punkte. Benutze entweder bucket_duration oder bucket_limit , aber nicht beides zusammen. |
REAKTION
{
"<metric1>": {
"data": [
{
"dimensions": {
"account": "<account>",
"<dim1>": "<key1>",
...
"<dimN>": "<keyN>"
},
"points": [
{
"timestamp": <bucket1>,
"value": <value1>
},
...,
{
"timestamp": <bucketN>,
"value": <valueN>
},
]
}
]
},
"<metric2>": {
...
},
...
}
Veranstaltungen
Der /v1/events
Endpunkt gibt Metriksummen für den gesamten oder einen Teil eines Live-Videostreams zurück.
In diesem Zusammenhang stellen eindeutige Metriken (ccu
, fingerprint_count
) den Gesamtwert über den Abfragebereich dar. So zum Beispiel eine Abfrage ohne from
/.to
Parameter geben die Gesamtzahl von zurück einzigartig Sitzungen (ccu) und / oder Geräte (fingerprint_count) für den gesamten Stream.
URI
/v1/events/accounts/$account
Weitere Parameter
keine
REAKTION
{
"data": [
{
"dimensions": {
"account": "<account>",
"<dim1>": "<key1>",
...
"<dimN>": "<keyN>"
},
"totals": {
"<metric1>": <value1>,
...
"<metricN>": <valueN>
}
}
]
}
Exportieren
Der Endpunkt Events bietet auch einen herunterladbaren Bericht:
/v1/events/accounts/$account/videos/$video/export?format=xlsx
Die Antwort ist eine XLSX-Datei mit Live-Metriken auf 4 Sheets:
- Zusammenfassung
- Gleichzeitige Nutzer
- Ansichten nach Gerätetyp
- Ansichten nach Geografie
Beispiele für die Verwendung
Für all diese Beispiele verwenden wir Account 1234, Video 5555, und gehen am 15. Februar 2020 von einer aktuellen UZeit von 12:00:00 Uhr UTCaus.
Holen Sie sich die aktuelle Viewer-Anzahl (CCU) für einen Live-Stream oder Kanal
Stellen Sie von auf vor mindestens 2 Minuten (11:58 Uhr) ein und verwenden Sie den letzten Punkt in der Antwort.
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581767880000
Holen Sie sich CCU-Diagrammpunkte für einen Live-Stream in den letzten 24 Stunden
Vergrößern (1-Minuten-Punkte)
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1m
Verkleinern (1-Stunden-Punkte)
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1h
Erhalte die maximale CCU pro Tag für einen Live-Kanal in den letzten 7 Tagen
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581206400000&bucket_duration=7d
Erhalten Sie jederzeit während eines Live-Streams die maximale CCU
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&bucket_limit=1
Holen Sie sich die gesamten einzigartigen Zuschauer und Sekunden für mehrere Live-Streams
Video 5555 ist abgeschlossen; die Zahlen sind endgültig. Video 5556 ist immer noch aktiv; Zahlen sind laufende Summen.
/v1/events/accounts/1234?dimensions=video&metrics=fingerprint_count,video_seconds_viewed&where=video==5555,5556
Holen Sie sich die Zuschauer- und Anzeigensummen für ein einstündiges Programm auf einem Live-Kanal <
Programm wird von 10:00 Uhr bis 11:00 Uhr ausgestrahlt (UTC)
/v1/events/accounts/1234?dimensions=video&metrics=alive_ss_ad_start,video_view,fingerprint_count&where=video==5555&from=1581760800000&to=1581764399999
Holen Sie sich die Zuschauerzahl nach Ländern für die Dauer eines Live-Streams
/v1/events/accounts/1234?dimensions=video,country&metrics=video_view,fingerprint_count&where=video==5555