Vai alla navigazione
LegacyUtilizzo

Recupera metriche di utilizzo dei caratteri

Deprecated

(Obsoleto) Questo endpoint è deprecato. Usa invece /v1/workspace/analytics/query/usage-by-product-over-time, che espone la dimensione del bucket come interval_seconds (un numero intero in secondi) anziché aggregation_interval. Restituisce le metriche di utilizzo per l’utente corrente o per l’intero workspace di cui fa parte. La risposta fornisce un asse temporale basato sull’intervallo di aggregazione specificato (predefinito: giorno), con i valori di utilizzo per ogni intervallo lungo tale asse. L’utilizzo è suddiviso in base al tipo di ripartizione selezionato. Ad esempio, il tipo di ripartizione “voice” restituisce l’utilizzo di ogni voce per ciascun intervallo lungo l’asse temporale.

Header

xi-api-keystringOpzionale

Parametri di query

start_unixintegerObbligatorio

Timestamp Unix UTC dell'inizio della finestra di utilizzo, in millisecondi. Per includere il primo giorno della finestra, il timestamp deve corrispondere alle 00:00:00 di quel giorno.

end_unixintegerObbligatorio

Timestamp Unix UTC della fine della finestra di utilizzo, in millisecondi. Per includere l'ultimo giorno della finestra, il timestamp deve corrispondere alle 23:59:59 di quel giorno.

include_workspace_metricsbooleanOpzionalePredefinito a false
Se includere le statistiche dell'intero workspace.
breakdown_typeenumOpzionale

Come suddividere le informazioni. Non può essere "user" se include_workspace_metrics è False.

aggregation_intervalenumOpzionale

Come aggregare nel tempo i dati di utilizzo. Può essere "hour", "day", "week", "month" o "cumulative".

Valori consentiti:
aggregation_bucket_sizeinteger or nullOpzionale
Dimensione del bucket di aggregazione in secondi. Sovrascrive l'intervallo di aggregazione.
metricenumOpzionale
Metrica da aggregare.

Risposta

Risposta riuscita
timelist of integers
L'asse temporale con timestamp Unix per ciascun giorno.
usagemap from strings to lists of doubles
L'utilizzo di ogni tipo di suddivisione lungo l'asse temporale.

Errori

422
Unprocessable Entity Error