Usage API

概述

Usage API 允许您从 OpenSpace 导出分析和报告数据。其主要用途是跟踪大型企业的使用情况。例如，如果您在多个站点和许多用户之间使用 OpenSpace，您将能够查看捕获的数量以及谁在使用这些数据，从而更全面地了解您从 OpenSpace 获得的价值。

权限

前提条件

• Usage API 仅适用于企业订阅。

入门

1. 登录 OpenSpace。
2. 点击左下角的头像，
3. 点击查看个人资料。
4. 在页面底部点击创建密钥。
5. 点击左上角的OpenSpace 标志或返回箭头退出个人资料页面。

使用分析数据

Usage API 旨在让您尽可能简单地围绕公司对 OpenSpace 的采用构建报告。

您可以以多种方式使用该 API，从简单地将数据导入电子表格，到复杂地为数据仓库提供数据。

Power BI

使用 Power BI 是开始使用 Usage API 数据最快的方法之一。我们创建了一个 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

headers = {

"api-key": api_key

}

# 使用 headers 发送 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。