API de Uso

Resumen

La API de Uso te permite exportar datos analíticos e informes desde OpenSpace. El uso principal es para rastrear el uso en grandes empresas. Por ejemplo, si estás usando OpenSpace en muchos sitios con muchos usuarios, podrás ver el volumen de capturas y quién está interactuando con los datos, para obtener una mejor idea del valor que estás obteniendo de OpenSpace.

Permisos

Requisitos previos

• La API de Uso está disponible con una suscripción Enterprise.

Primeros pasos

1. Inicia sesión en OpenSpace.
2. Selecciona tu avatar en la esquina inferior izquierda,
3. Haz clic en Ver perfil.
4. Haz clic en Crear clave en la parte inferior de la página.
5. Haz clic en el logo de OpenSpace en la esquina superior izquierda o en la flecha hacia atrás para salir de la página de Perfil.

Uso de los datos analíticos

La API de Uso está diseñada para facilitar al máximo la creación de informes sobre la adopción de OpenSpace en tu empresa.

Puedes usar la API de muchas maneras, desde algo tan simple como obtener datos en una hoja de cálculo hasta algo tan complejo como proporcionar datos para un almacén de datos.

Power BI

Una de las formas más rápidas de comenzar a usar los datos de la API de Uso es a través de Power BI. Hemos creado un archivo de plantilla de Power BI para ayudarte a empezar. Simplemente descarga la plantilla, ingresa tu clave API y tendrás un conjunto inicial de visualizaciones.

Plantilla de API de Uso de OpenSpace

Video que muestra cómo usar la plantilla de Power BI

Python

Si no tienes Power BI, puedes comenzar a aprovechar la API de Uso de forma gratuita con código Python. Una forma fácil de empezar a usar Python es en Google Colab.

Extracción de Datos

!pip install -U altair

import requests

import json

import pandas as pd

import pprint

import altair as alt

# Definir el endpoint de la API

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

# Obtener la clave API de Secrets

from google.colab import userdata

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

# Definir encabezados con la clave API en un encabezado personalizado

headers = {

"api-key": api_key

}

# Realizar la solicitud GET con encabezados

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

# Imprimir el código de estado para verificar la autenticación

print("Código de Estado:", response.status_code)

# Convertir la salida a JSON

data = response.json()

Formatear los Datos

# Convertir la lista 'content' de diccionarios a un DataFrame de pandas

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

# Mostrar las primeras filas del DataFrame

df.head()

Graficar los Datos

alt.renderers.enable('colab')

chart = alt.Chart(df

).mark_bar(

).encode(

x=alt.X('yearmonth(videoStart):O', title='Mes'), # Agrupado por año y mes

y='videoNumberOfFrames',

color='siteName',

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

).properties(

width=800,

height=600

).interactive()

chart.display()

Continuación de la Gráfica de Datos

# Crear tabla dinámica

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

# Importar paquetes para mapa de calor

import matplotlib.pyplot as plt

import seaborn as sns

# Graficar el mapa de calor

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

Preguntas Frecuentes

¿Qué datos se pueden obtener a través de la API de Uso?

Para obtener la información más actualizada, visita https://api.us.openspace.ai/swagger-ui/index.html#/Reports para la lista de opciones de informes.

Si tienes preguntas adicionales, por favor contacta al equipo de Soporte de OpenSpace en support@openspace.ai.