LegacyUsage

Obtener métricas de uso de caracteres

Deprecated
(Obsoleto) Esta ruta de API está obsoleta. Usa /v1/workspace/analytics/query/usage-by-product-over-time en su lugar, que expone el tamaño del intervalo como `interval_seconds` (un entero en segundos) en vez de `aggregation_interval`. Devuelve las métricas de uso del usuario actual o de todo el espacio de trabajo al que pertenece. La respuesta proporciona un eje temporal basado en el intervalo de agregación especificado (predeterminado: día), con valores de uso para cada intervalo de ese eje. El uso se desglosa según el tipo de desglose seleccionado. Por ejemplo, el tipo de desglose "voice" devolverá el uso de cada voz en cada intervalo del eje temporal.

Encabezados

xi-api-keystringOpcional

Parámetros de consulta

start_unixintegerRequerido

Marca de tiempo Unix UTC del inicio de la ventana de uso, en milisegundos. Para incluir el primer día de la ventana, la marca de tiempo debe corresponder a las 00:00:00 de ese día.

end_unixintegerRequerido

Marca de tiempo Unix UTC del final de la ventana de uso, en milisegundos. Para incluir el último día de la ventana, la marca de tiempo debe corresponder a las 23:59:59 de ese día.

include_workspace_metricsbooleanOpcionalValor predeterminado: false

Indica si se deben incluir las estadísticas de todo el espacio de trabajo.

breakdown_typeenumOpcional

Cómo desglosar la información. No puede ser “user” si include_workspace_metrics es False.

aggregation_intervalenumOpcional

Cómo agregar los datos de uso a lo largo del tiempo. Puede ser “hour”, “day”, “week”, “month” o “cumulative”.

Valores permitidos:
aggregation_bucket_sizeinteger or nullOpcional

Tamaño del intervalo de agregación en segundos. Anula el intervalo de agregación.

metricenumOpcional

Qué métrica agregar.

Respuesta

Respuesta correcta.
timelist of integers

El eje temporal con marcas de tiempo Unix para cada día.

usagemap from strings to lists of doubles
El uso de cada tipo de desglose a lo largo del eje temporal.

Errores

422
Unprocessable Entity Error