Usage API

概要

Usage API を使用すると、OpenSpace から分析およびレポートデータをエクスポートできます。主な用途は、大規模な企業全体での使用状況を追跡することです。たとえば、多くのサイトで多くのユーザーが OpenSpace を使用している場合、キャプチャの量やデータに関与しているユーザーを確認でき、OpenSpace から得られる価値をより完全に把握できます。

権限

前提条件

• Usage API はエンタープライズサブスクリプションで利用可能です。

はじめに

1. OpenSpace にログインします。
2. 左下のアバターを選択します。
3. プロフィールを見るをクリックします。
4. ページ下部のキーを作成をクリックします。
5. プロフィールページを終了するには、左上のOpenSpace ロゴまたは戻る矢印をクリックします。

分析データの使用

Usage API は、貴社の OpenSpace 採用状況に関するレポートを簡単に作成できるよう設計されています。

スプレッドシートにデータを取り込むような簡単な使い方から、データウェアハウスにデータを提供するような複雑な使い方まで、多様な方法で API を利用できます。

Power BI

Usage API データを使い始める最も速い方法の一つは Power BI を利用することです。開始を支援する Power BI テンプレートファイルを作成しました。テンプレートをダウンロードし、API キーを入力するだけで、初期のビジュアライゼーションセットが利用可能になります。

OpenSpace Usage API テンプレート

Power BI テンプレートの使用方法を示すビデオ

Python

Power BI をお持ちでない場合は、Python コードで無料で Usage API を活用開始できます。Python を使い始める簡単な方法は Google Colabです。

データ抽出

!pip install -U altair

import requests

import json

import pandas as pd

import pprint

import altair as alt

# API エンドポイントを定義

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

# Secrets から API キーを取得

from google.colab import userdata

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

# カスタムヘッダーに API キーを定義

headers = {

"api-key": api_key

}

# ヘッダー付きで GET リクエストを送信

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

# 認証を確認するためステータスコードを表示

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

# 出力を JSON に変換

data = response.json()

データの整形

# 'content' の辞書リストを pandas DataFrame に変換

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

# DataFrame の最初の数行を表示

df.head()

データのプロット

alt.renderers.enable('colab')

chart = alt.Chart(df

).mark_bar(

).encode(

x=alt.X('yearmonth(videoStart):O', title='月'), # 年月単位でビン分け

y='videoNumberOfFrames',

color='siteName',

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

).properties(

width=800,

height=600

).interactive()

chart.display()

継続的なデータプロット

# ピボットテーブルを作成

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

# ヒートマップ用のパッケージをインポート

import matplotlib.pyplot as plt

import seaborn as sns

# ヒートマップをプロット

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

よくある質問 (FAQ)

Usage API で取得できるデータは何ですか？

最新情報を得るには、 https://api.us.openspace.ai/swagger-ui/index.html#/Reports をご覧ください。レポートオプションの一覧があります。

その他のご質問がある場合は、OpenSpace サポートチームまでお問い合わせください。support@openspace.ai。