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。一個簡單的起點是在 Google Colab中使用 Python。

提取數據

!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("狀態碼:", 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')

常見問題

可以透過 Usage API 取得哪些數據？

欲取得最新資訊，請造訪 https://api.us.openspace.ai/swagger-ui/index.html#/Reports 以查看報告選項清單。

若有其他問題，請聯繫 OpenSpace 支援團隊，電子郵件為 support@openspace.ai。