Support Kontakt Support | Systemstatus Systemstatus

Übersicht: Dimensionen, Felder und Parameter

Dimensionen sind die Schlüsseldatenkategorien für Analytics API Datenberichte. Dieses Thema enthält eine interaktive Anleitung zu Dimensionen und den Feldern, die für sie zurückgegeben werden können. Außerdem wird angezeigt, welche Dimensionen in einem Bericht kombiniert werden können und welche Felder für die verschiedenen Kombinationen zur Verfügung stehen.

Abmessungen und Felder

Dimensionen sind die primären Datenbereiche für Analysen. Klicken Sie auf den Dimensionsnamen in der Liste unten, um vollständige Anleitungen zu den einzelnen Dimensionen anzuzeigen.

Wählen Sie Dimension (en) unten, um die Felder zu sehen, die dafür zurückgegeben werden können. Sie können auch auf klicken Eine Anfrage stellen Knopf, um eine Beispielanforderung zu machen und die Ergebnisse zu sehen. Wenn Sie mehrere inkompatible Dimensionen auswählen, wird eine entsprechende Meldung angezeigt.

Eingang

Wählen Sie Dimension (en) für die Berichterstattung aus:

Felder, die zurückgegeben werden sollen:

(verwendet ein Brightcove-Beispielkonto)

Ausgabe

Älteste from Datum für diese Dimensionskombination:  

Beispiel-API-Anfrage:

Antwortdaten

  Response will appear here...

Wichtige Informationen

  1. Standardmäßig video_view ist das einzige Feld, das zurückgegeben wird - andere Felder werden nur zurückgegeben, wenn sie im Wert von fields Parameters.
  2. Wenn Sie ein zurückzugebendes Feld angeben, das für die Dimension oder die Dimensionskombination nicht unterstützt wird, und UNSUPPORTED_FIELD_COMBINATION_ERROR Fehler wird zurückgegeben.
  3. Unser bytes_delivered Das Feld enthält alle Daten, die von geliefert wurden Video Cloud an Kunden, einschließlich Videodaten, Bilder, Textspuren und anderer Assets sowie der player Code selbst. Einige dieser Daten stammen von CDNs und sind möglicherweise bis zu 3 Tage nicht verfügbar.
  4. Zusätzlich zu den angezeigten Feldern für video Dimension können Sie auch zurückkehren video.custom_fields.{field_name}

Beispiel Anfrage

Ein typischer Anwendungsfall für das Abrufen eines Berichts zu mehreren Dimensionen: Sie möchten eine Aufschlüsselung der Videoaufrufe zwischen Desktop- und Mobilgeräten und möchten außerdem wissen, wie viele Mobilgeräteansichten auf iOS- und Android-Geräten und wie viele Desktops angezeigt wurden Ansichten waren auf Macs gegen Windows-Maschinen. Momentan gibt es im Studio Analytics-Modul keinen Standardbericht, der diese Informationen bereitstellt, Sie können ihn jedoch über diesen erhalten Analytics API Anruf:

  https://analytics.api.brightcove.com/v1/data?accounts=57838016001&dimensions=video,device_type,device_os&from=2014-01-01&to=2014-04-01&fields=video_view

(In diesem Fall werden Video-Views für den Zeitraum von Januar 1 bis April 1 in 2014 angefordert.)

Beispiel mit cURL

Wenn Sie die API mit ausprobieren möchten cURL, hier sind ein paar Notizen:

  • Sie müssen zuerst einen bekommen Zugangstoken
  • Da die URL für die Anfrage immer enthalten ist URL-Parameter, müssen Sie es in Anführungszeichen setzen (einfach oder doppelt)

Probe

Hier ist ein Beispiel cURL Befehl:

  curl -s --header "Authorization: Bearer $ACCESS_TOKEN" \
  "https://analytics.api.brightcove.com/v1/data?accounts=$ACCOUNT_ID&dimensions=video&from=2017-04-04&limit=100"

Wenn Sie ersetzen $ACCESS_TOKEN mit einem gültigen Zugriffstoken und $ACCOUNT_ID Mit Ihrer Konto-ID sollte diese Anforderung funktionieren. Beachten Sie, dass Sie verwenden können Dieses Beispiel App ein Zugriffstoken generieren.

Unterstützte Dimensionskombinationen

Zur schnellen Bezugnahme zeigt die folgende Tabelle die unterstützten oder nicht unterstützten Bemaßungskombinationen. Beachten Sie, dass es in einigen Fällen mehr als zwei Dimensionen gibt. Sie können diese mit Hilfe der Dimensionen und Felder Werkzeug oben.

Unterstützte Dimensionskombinationen
account browser_type city country date date_hour destination_domain destination_path device_os device_manufacturer device_type live_stream player referrer_domain region search_terms social_platform source_type video
account n / a Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja
browser_type Ja n / a Ja Ja
city Ja n / a Ja Ja Ja Ja
country Ja Ja n / a Ja Ja Ja Ja Ja Ja
date n / a
date_hour n / a
destination_domain Ja Ja Ja n / a Ja Ja
destination_path Ja Ja Ja n / a
device_os Ja Ja Ja Ja n / a Ja Ja Ja
device_manufacturer Ja Ja Ja n / a
device_type Ja Ja Ja Ja n / a Ja Ja Ja
live_stream Ja Ja n / a
player Ja Ja Ja Ja Ja Ja Ja n / a Ja Ja Ja
referrer_domain Ja Ja Ja Ja n / a Ja Ja Ja
region Ja Ja Ja Ja Ja Ja Ja n / a
search_terms Ja Ja Ja Ja n / a Ja
social_platform Ja Ja n / a Ja
source_type Ja Ja Ja Ja Ja Ja n / a Ja
video Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja Ja n / a

Parameter

Im Folgenden finden Sie eine Tabelle mit den verfügbaren Parametern in der Analytics API. Die Verwendung der Parameter wird in den folgenden Abschnitten ausführlicher erläutert.

Parameter Erforderlich Beschreibung Werte Default

Konten

Unser Video Cloud Konto (n), für das Sie einen Bericht erstellen möchten, werden mithilfe von angegeben accounts Parameter. Zum Beispiel:

  https://analytics.api.brightcove.com/v1/data?accounts={account1_id,account2_id}

Wo Filter

Die allgemeine Syntax für Filter lautet:

where=dimension1==value1;dimension2==value2

Beispielsweise:

https://analytics.api.brightcove.com/v1?accounts=account_id(s)&dimensions=device_type&where=video==video_id;device_type==tablet

Kommas werden als logische ORs und Semikolons als logische UNDs behandelt. Beispielsweise, where=video==1234,5678;player==9876 wird interpretiert als "where video = 1234 OR 5678 UND player = 9876 "

Leerzeichen und Sonderzeichen

String-Werte sollten URI-codiert sein. Sie können Sonderzeichen auch mit einem "" umgehen:

where=search_terms==boston,%20ma

Sie können jede Dimension als Filter verwenden. aber ausschließlich wenn diese Dimension auch in der enthalten ist dimensions du fragst

Filtern nach Videoeigenschaften

Das Besondere benutzen where=video.q=={property}:{value} Filter können Sie Ihren Bericht basierend auf einer Vielzahl von Eigenschaften auf bestimmte Videos beschränken:

  • Tags
  • Referenz ID
  • custom_fields [1]
  • {a_specific_custom_field}
  • hergestellt in

Wichtige Informationen

[1] Die grundlegende Syntax ist where=video.q==custom_fields:value (entspricht dem Wert in einem benutzerdefinierten Feld) oder where=video.q==myfield:value (entspricht dem Wert im spezifischen benutzerdefinierten Feld myfield). Wenn Sie nach bestimmten benutzerdefinierten Feldern suchen, beachten Sie, dass Sie auf der Seite suchen müssen Interner Name, nicht der Anzeigename:

Interner Name im Vergleich zum Anzeigenamen
Interner Name im Vergleich zum Anzeigenamen

Eine schnelle Überprüfung, ob Sie den richtigen Namen verwenden: Der interne Name wird sein alles Kleinbuchstaben und enthalten keine Leerzeichen.

Beispiele

Hier sind einige Beispiele where Filter für die Suche nach Tags und benutzerdefinierten Feldern:

Einfaches Tag
where=video.q==tags:foo
Mehrere Tags:
where=video.q==tags:foo,bar
Benutzerdefinierte Felder
where=video.q==custom_fields:foo
Tags und benutzerdefinierte Felder
where=video.q==tags:foo,bar+custom_fields:fish

Eine vollständige Erläuterung dieser Abfragesyntax finden Sie unter Verwendung der CMS API: Suche nach Videos.

Zusammenfassung der Filter und zulässigen Werte

Die folgende Tabelle zeigt zulässige Werte für jede Dimension, die als Filter verwendet wird:

Dimensionsfilter Zulässige Werte

Datumsbereiche

Datumsbereiche, angegeben in from und to Parameter für alle Arten von Berichten können in verschiedenen Formaten angezeigt werden:

  • Textwerte:
    • from=alltime
    • to=now (verfügbar und der Standardwert für alle Anfragen)
  • Epochenzeitwerte in Millisekunden, wie z 1377047323000
  • Daten, die im internationalen Datumsformat ISO 8601 ausgedrückt werden: YYYY-MM-DDFormat, wie z 2013-09-12. Für Daten in diesem Format ausgedrückt:
    • Jeder angegebene Datumsbereich wird interpretiert in der für das Konto festgelegten Zeitzone
    • Die Uhrzeit für das Datum wird als Mitternacht interpretiert ( 00:00:00) zum angegebenen Datum in der für das Konto festgelegten Zeitzone
  • Relative Daten: Sie können entweder die to und from Werte relativ zu den anderen in d (Tage) oder h (Stunden). Beispielsweise:
    • from=2015-01-01&to=31d
    • from=-48h&to=now
    • from=-2d&to=now (wird die gleichen Ergebnisse wie das vorherige Beispiel geben)
    • from=-365d&to=2014-12-31

    Beachten Sie, dass negative Zahlen (-2d) als "vor" (der andere Wert) interpretiert werden und positive Zahlen (48h) als "von" (der andere Wert) behandelt werden.

Um einen Bericht zu einer Dimension wie "Video" für einen einzelnen Tag zu erstellen, legen Sie die Werte für "An" und "Von" auf das Datum fest:

...&dimensions=video&from=2013-11-01&to=2013-11-01

Limit und Offset

Unser limit ist die Anzahl der zurückzugebenden Elemente (Standard: 10). Um alle Artikel zurückzugeben, verwenden Sie limit=all. offset ist die Anzahl der zu überspringenden Elemente (Standard: 0). Sie können verwenden limit und offset zusammen, um eine App zu erstellen, die die Ergebnisse durchsucht.

Abgestimmte Daten

Unser reconciled Parameter ist ein boolescher Wert. Wenn es auf eingestellt ist true, werden die Ergebnisse auf abgeglichene Daten beschränkt. Ob falseDie Ergebnisse sind auf Echtzeitdaten (stündlich nicht abgestimmt) beschränkt.

Geografische Berichte

Dimensionen für die geografische Analyse

  • country - Als ISO-3611-1 Ländercode. zB: "USA"
  • region - Als ISO-3611-2-Regionscode. zB: 'US-WA'
  • city - Stadtname. zB: Seattle

Hinweis: Für unbekanntes Land oder Region gibt die API "ZZ" als Code zurück (gemäß ISO-3611-alpha2).

Felder und Sortieren

Verwenden Sie das fields Parameter, um die Felder anzugeben, die Sie zurückgeben möchten. Standardmäßig, video_view wird zurückgegeben und das Feld, das der Dimension entspricht, über die Sie berichten (z. B. destination_domain) werden zurückgegeben. Sehen Dimensionen und Felder für weitere Informationen.

Verwenden Sie das sort Parameter, um anzugeben, welches Metrikfeld zum Sortieren der zurückgegebenen Elemente verwendet wird; beispielsweise: sort=video_view. Sie können die Sortierreihenfolge umkehren, indem Sie das Sortierfeld negieren: sort= -video_view

Berechnete Felder

Sie können berechnete Felder zu Ihren API-Anforderungen hinzufügen, indem Sie die folgende Syntax verwenden:

fields=calulated_field_name:expression

Sie können berechnete Felder verwenden, um eigene benutzerdefinierte Felder aus vorhandenen Metriken zu erstellen oder ein vorhandenes Feld umzubenennen.

Der Name für das berechnete Feld kann eine beliebige URI-kompatible Zeichenfolge sein. Der Ausdruck kann reguläre Feldnamen und die folgenden arithmetischen Operatoren enthalten:

  • + (Zusatz)
  • - (Subtraktion)
  • * (Multiplikation)
  • / (Aufteilung)
  • ^ (Exponent)
  • () (Klammern)

Beispiele

fields=avg_seconds_viewed:video_seconds_viewed/video_view,video.name
fields=avg_incomplete_ads:(ad_mode_begin-ad_mode_complete)/video_view,video.name
fields=Video%20Views:video_view,video.name

Musteranfrage

Beispielantwort (auf die obige Anfrage)

{
  "item_count": 110,
  "items": [
    {
      "avg_seconds_viewed": 2152.2519913106444,
      "video.name": "Flamingos",
      "video_seconds_viewed": 2972260,
      "video": "4825279519001",
      "video_view": 1381
    },
    {
      "avg_seconds_viewed": 14.016225448334756,
      "video.name": "Tiger",
      "video_seconds_viewed": 16413,
      "video": "4093643993001",
      "video_view": 1171
    },
    {
      "avg_seconds_viewed": 12.06,
      "video.name": "Zebra",
      "video_seconds_viewed": 9045,
      "video": "3851389913001",
      "video_view": 750
    },
    {
      "avg_seconds_viewed": 23.343065693430656,
      "video.name": "Sea-SeaTurtle",
      "video_seconds_viewed": 15990,
      "video": "1754276205001",
      "video_view": 685
    }
  ],
  "summary": {
    "avg_seconds_viewed": 274.27374399301004,
    "video_seconds_viewed": 3139063,
    "video_view": 11445
  }
}

Seite zuletzt aktualisiert am 12. Juni 2020