Usage API

Überblick

Die Usage API ermöglicht es Ihnen, Analyse- und Berichtsdaten aus OpenSpace zu exportieren. Der Hauptzweck besteht darin, die Nutzung in großen Unternehmen zu verfolgen. Zum Beispiel, wenn Sie OpenSpace an vielen Standorten mit vielen Benutzern verwenden, können Sie das Volumen der Aufnahmen und die Nutzer, die mit den Daten interagieren, einsehen, um ein umfassenderes Verständnis des Wertes zu erhalten, den Sie durch OpenSpace gewinnen.

Berechtigungen

Voraussetzungen

• Die Usage API ist mit einem Enterprise-Abonnement verfügbar.

Erste Schritte

1. Melden Sie sich bei OpenSpace an.
2. Wählen Sie Ihr Avatar-Symbol unten links aus,
3. Klicken Sie auf Profil anzeigen.
4. Klicken Sie unten auf der Seite auf Schlüssel erstellen.
5. Klicken Sie auf das OpenSpace-Logo oben links oder auf den Zurück-Pfeil, um die Profilseite zu verlassen.

Verwendung der Analysedaten

Die Usage API ist so konzipiert, dass es möglichst einfach ist, Berichte über die Nutzung von OpenSpace in Ihrem Unternehmen zu erstellen.

Sie können die API auf vielfältige Weise nutzen, von etwas so Einfachem wie dem Import der Daten in eine Tabellenkalkulation bis hin zu komplexen Anwendungen wie der Bereitstellung von Daten für ein Data Warehouse.

Power BI

Eine der schnellsten Möglichkeiten, die Usage API-Daten zu verwenden, ist über Power BI. Wir haben eine Power BI-Vorlagendatei erstellt, die Ihnen den Einstieg erleichtert. Laden Sie einfach die Vorlage herunter, geben Sie Ihren API-Schlüssel ein, und Sie erhalten eine erste Reihe von Visualisierungen.

OpenSpace Usage API Vorlage

Video zur Verwendung der Power BI-Vorlage

Python

Falls Sie kein Power BI haben, können Sie die Usage API kostenlos mit Python-Code nutzen. Eine einfache Möglichkeit, Python zu verwenden, ist in Google Colab.

Daten extrahieren

!pip install -U altair

import requests

import json

import pandas as pd

import pprint

import altair as alt

# Definieren des API-Endpunkts

url = "https://api.us.openspace.ai/api/external/v1/reports/360-videos?size=100000&sort=videoStart%2CDESC"

# API-Schlüssel aus Geheimnissen abrufen

from google.colab import userdata

api_key = userdata.get('api-key')

# Header mit dem API-Schlüssel in einem benutzerdefinierten Header definieren

headers = {

"api-key": api_key

}

# GET-Anfrage mit Headern senden

response = requests.get(url, headers=headers)

# Statuscode ausgeben, um die Authentifizierung zu überprüfen

print("Status Code:", response.status_code)

# Ausgabe in JSON umwandeln

data = response.json()

Daten formatieren

# Die 'content'-Liste von Dictionaries in ein pandas DataFrame umwandeln

df = pd.DataFrame(data['content'])

# Die ersten Zeilen des DataFrames anzeigen

df.head()

Daten visualisieren

alt.renderers.enable('colab')

chart = alt.Chart(df

).mark_bar(

).encode(

x=alt.X('yearmonth(videoStart):O', title='Monat'), # Gruppiert nach Jahr und Monat

y='videoNumberOfFrames',

color='siteName',

tooltip=['videoStart', 'videoNumberOfFrames', 'siteName']

).properties(

width=800,

height=600

).interactive()

chart.display()

Fortsetzung der Datenvisualisierung

# Pivot-Tabelle erstellen

pivot_table = pd.pivot_table(df, values='videoId', index='siteName', columns='week', aggfunc='count', fill_value=0)

# Pakete für Heatmap importieren

import matplotlib.pyplot as plt

import seaborn as sns

# Heatmap zeichnen

sns.heatmap(pivot_table, cmap='RdYlGn')

FAQ

Welche Daten können über die Usage API abgerufen werden?

Um die aktuellsten Informationen zu erhalten, besuchen Sie https://api.us.openspace.ai/swagger-ui/index.html#/Reports für die Liste der Berichtsmöglichkeiten.

Wenn Sie weitere Fragen haben, wenden Sie sich bitte an das OpenSpace Support-Team unter support@openspace.ai.