Analytics API: Live Metrik

Einführung

Wiedergabemetriken für Live Streams von der Brightcove Live Service sind in Echtzeit über die Analtyics API. Diese Daten werden für erfasst Live-Streams nur; 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 Dokumente.

Metrik

Dies sind die Metriken, die über die verfügbar sind Live Endpunkte. Abfragen können mehrere Metriken anfordern.

Metrisch	Beschreibung
`alive_ss_ad_start`	Serverseitige Anzeigenimpressionen
`ccu`	Unique Sessions;; Anzahl der verschiedenen (Fingerabdruck + Session)
`fingerprint_count`	Unique Geräte;; Anzahl der verschiedenen Fingerabdrücke (siehe unten)
`video_impression`	Häufigkeit, mit der Videos geladen wurden player
`video_seconds_viewed`	Gesamtanzahl der Sekunden, die von allen Zuschauern gesehen wurden
`video_view`	Stream startet (nicht eindeutig)

Für einzigartig Tracking weisen wir a Fingerabdruck zu jedem Gerät durch Kombinieren (Remote IP + User-Agent + Player). Beachten Sie, dass wir keine tatsächliche Hardware-ID vom Gerät selbst verwenden. Dies verringert die Genauigkeit, hält uns jedoch datenschutzkonform.

Maße

Die folgenden Kombinationen werden unterstützt als dimensions und where Filterschlüssel:

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
Größe	`<dim1>,<dim2>,...`	Y	-	Abfragedimensionen (GROUP BY)
Metrik	`<metric1>,<metric2>,...`	Y	-	Eine oder mehrere zu meldende Metriken
woher	`<dim1>=<value1>;...`	Y	-	Ein oder mehrere Abfragefilter; muss mindestens 1 Video enthalten
von der	`<epoch>`	N	0	Zeitbereich beginnen
zu	`<epoch>`	N	Jetzt	Zeitbereichsende

Zeitfolgen

Unser /v1/timeseries Der Endpunkt gibt eine Liste von Punkten entlang einer Zeitachse mit dem Wert der angeforderten Metrik zu jedem Zeitpunkt zurück. Punkte sind 1 Minuten Buckets standardmäßig, können aber über einen Parameter geändert werden.

In diesem Zusammenhang eindeutige Metriken (ccu, fingerprint_count) geben die höchster Wert jederzeit während jedes Eimers. Also eine Abfrage mit bucket_duration=1d gibt die maximale Parallelität für jeden Tag zurück, während eine Abfrage mit bucket_limit=1 gibt die maximale Parallelität an jedem Punkt im Stream zurück.

URI

/v1/timeseries/accounts/$account

Zusätzliche Parameter

Parameter	Syntax	Erforderlich	Default	Beschreibung
Bucket_Duration	`<n>m` (Protokoll) `<n>h` (Std) `<n>d` (Tage)	N	1m	Dauer durch jeden Punkt dargestellt. `1d` ist 24 Stunden, kein Kalendertag.
Bucket_Limit	`<n>`	N	-	Anzahl der zurückzugebenden Punkte. Benutze das eine oder das andere `bucket_duration` or `bucket_limit`, aber nicht beide zusammen.

Antwort

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

Veranstaltungen

Unser /v1/events Der Endpunkt gibt metrische Summen für alle oder einen Teil von a zurück Live Videostream.

In diesem Zusammenhang eindeutige Metriken (ccu, fingerprint_count) repräsentieren die Gesamtwert über den Abfragebereich. 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

Zusätzliche Parameter

keiner

Antwort

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

Export

Der Ereignisendpunkt 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 Blättern:

Zusammenfassung
Gleichzeitige Benutzer
Ansichten nach Gerätetyp
Ansichten nach Geographie

Anwendungsbeispiele

Für all diese Beispiele verwenden wir Konto 1234, Video 5555und nehmen eine aktuelle Zeit von an 12:00:00 UTC on Feb 15th, 2020.

Holen Sie sich die aktuelle Viewer-Anzahl (CCU) für a Live Stream oder Kanal

Setzen von der bis vor mindestens 2 Minuten (11:58 Uhr), und verwenden Sie die letzte Punkt in der Antwort.

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

Holen Sie sich CCU-Diagrammpunkte für a 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

Holen Sie sich die maximale CCU pro Tag für a Live Kanal in den letzten 7 Tagen

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

Erhalten Sie jederzeit die maximale CCU während eines Live Strom

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

Holen Sie sich die Gesamtzahl der eindeutigen Viewer und Sekunden, die für mehrere angezeigt werden Live Ströme

Video 5555 wurde abgeschlossen; Zahlen sind endgültig. Video 5556 ist noch aktiv; Zahlen laufen 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 a Live Kanal<

Programm ausgestrahlt von 10:00 bis 11:00 Uhr (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 von a Live Strom

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