Ir para a navegação
LegadoUso

Obter métricas de uso de caracteres

Deprecated

(Obsoleto) Este endpoint está obsoleto. Use /v1/workspace/analytics/query/usage-by-product-over-time, que expõe o tamanho do intervalo como interval_seconds (um inteiro em segundos), em vez de aggregation_interval. Retorna as métricas de uso do usuário atual ou de todo o workspace do qual ele faz parte. A resposta fornece um eixo temporal com base no intervalo de agregação especificado (padrão: dia), com valores de uso para cada intervalo nesse eixo. O uso é dividido pelo tipo de detalhamento selecionado. Por exemplo, o tipo de detalhamento “voice” retorna o uso de cada voz para cada intervalo no eixo temporal.

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

start_unixintegerObrigatório

Carimbo de data/hora Unix UTC para o início da janela de uso, em milissegundos. Para incluir o primeiro dia da janela, o carimbo de data/hora deve ser às 00:00:00 desse dia.

end_unixintegerObrigatório

Carimbo de data/hora Unix UTC para o fim da janela de uso, em milissegundos. Para incluir o último dia da janela, o carimbo de data/hora deve ser às 23:59:59 desse dia.

include_workspace_metricsbooleanOpcionalPadrão é false

Se as estatísticas de todo o workspace devem ser incluídas.

breakdown_typeenumOpcional

Como detalhar as informações. Não pode ser “user” se include_workspace_metrics for False.

aggregation_intervalenumOpcional
Como agregar os dados de uso ao longo do tempo. Pode ser "hour", "day", "week", "month" ou "cumulative".
Valores permitidos:
aggregation_bucket_sizeinteger or nullOpcional

Tamanho do intervalo de agregação em segundos. Substitui o intervalo de agregação.

metricenumOpcional

Qual métrica agregar.

Resposta

Resposta bem-sucedida

timelist of integers
O eixo temporal com timestamps Unix para cada dia.
usagemap from strings to lists of doubles
O uso de cada tipo de detalhamento ao longo do eixo temporal.

Erros

422
Unprocessable Entity Error