Usage API

Overzicht

De Usage API stelt je in staat om analytics- en rapportagegegevens uit OpenSpace te exporteren. Het primaire gebruik is om het gebruik binnen grote ondernemingen te volgen. Bijvoorbeeld, als je OpenSpace op veel locaties met veel gebruikers gebruikt, kun je het volume van vastgelegde gegevens en wie er met de data bezig is zien, om zo een vollediger beeld te krijgen van de waarde die je uit OpenSpace haalt.

Rechten

Vereisten

• De Usage API is beschikbaar met een Enterprise-abonnement.

Aan de slag

1. Log in op OpenSpace.
2. Selecteer je avatar linksonder,
3. Klik op Profiel bekijken.
4. Klik onderaan de pagina op Sleutel aanmaken.
5. Klik op het OpenSpace-logo linksboven of op de terug-pijl om de profielpagina te verlaten.

Gebruik van de analytics-gegevens

De Usage API is ontworpen om het zo eenvoudig mogelijk te maken om rapportages te bouwen rondom de adoptie van OpenSpace binnen jouw bedrijf.

Je kunt de API op vele manieren gebruiken, van iets eenvoudigs zoals data in een spreadsheet krijgen tot iets complexers zoals het leveren van data aan een datawarehouse.

Power BI

Een van de snelste manieren om te starten met de Usage API data is via Power BI. We hebben een Power BI-sjabloonbestand gemaakt om je op weg te helpen. Download simpelweg de template, voer je API-sleutel in en je hebt een eerste set visualisaties.

OpenSpace Usage API Template

Video die laat zien hoe je de Power BI Template gebruikt

Python

Als je geen Power BI hebt, kun je gratis beginnen met het benutten van de Usage API met Python-code. Een gemakkelijke manier om Python te gebruiken is in Google Colab.

Data extraheren

!pip install -U altair

import requests

import json

import pandas as pd

import pprint

import altair as alt

# Definieer het API-eindpunt

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

# Haal API-sleutel op uit Secrets

from google.colab import userdata

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

# Definieer headers met de API-sleutel in een custom header

headers = {

"api-key": api_key

}

# Maak de GET-aanvraag met headers

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

# Print de statuscode om authenticatie te verifiëren

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

# Converteer de output naar JSON

data = response.json()

Data formatteren

# Converteer de 'content' lijst van dictionaries naar een pandas DataFrame

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

# Toon de eerste paar rijen van de DataFrame

df.head()

Data plotten

alt.renderers.enable('colab')

chart = alt.Chart(df

).mark_bar(

).encode(

x=alt.X('yearmonth(videoStart):O', title='Maand'), # Gebundeld per jaar en maand

y='videoNumberOfFrames',

color='siteName',

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

).properties(

width=800,

height=600

).interactive()

chart.display()

Vervolg Data plotten

# Maak een draaitabel

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

# Importeer pakketten voor heatmap

import matplotlib.pyplot as plt

import seaborn as sns

# Plot de heatmap

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

FAQ

Welke data kan worden opgehaald via de Usage API?

Voor de meest actuele informatie, bezoek https://api.us.openspace.ai/swagger-ui/index.html#/Reports voor de lijst met rapportage-opties.

Als je nog vragen hebt, neem dan contact op met het OpenSpace Support-team via support@openspace.ai.