Passer à la navigation
HéritageUtilisation

Obtenir les métriques d’utilisation des caractères

Deprecated

(Obsolète) Ce point de terminaison est obsolète. Utilisez plutôt /v1/workspace/analytics/query/usage-by-product-over-time, qui expose la taille du compartiment sous la forme de interval_seconds (un entier en secondes) plutôt que aggregation_interval. Renvoie les métriques d’utilisation de l’utilisateur actuel ou de l’ensemble du Workspace auquel il appartient. La réponse fournit un axe temporel basé sur l’intervalle d’agrégation spécifié (par défaut : jour), avec les valeurs d’utilisation pour chaque intervalle de cet axe. L’utilisation est ventilée selon le type de ventilation sélectionné. Par exemple, le type de ventilation « voice » renvoie l’utilisation de chaque voix pour chaque intervalle de l’axe temporel.

En-têtes

xi-api-keystringOptionnel

Paramètres de requête

start_unixintegerRequis

Horodatage Unix UTC du début de la période d’utilisation, en millisecondes. Pour inclure le premier jour de la période, l’horodatage doit correspondre à 00:00:00 ce jour-là.

end_unixintegerRequis

Horodatage Unix UTC de la fin de la période d’utilisation, en millisecondes. Pour inclure le dernier jour de la période, l’horodatage doit correspondre à 23:59:59 ce jour-là.

include_workspace_metricsbooleanOptionnelPar défaut false

Indique si les statistiques de l’ensemble du Workspace doivent être incluses.

breakdown_typeenumOptionnel

Méthode de ventilation des informations. Ne peut pas être “user” si include_workspace_metrics est False.

aggregation_intervalenumOptionnel

Méthode d’agrégation des données d’utilisation au fil du temps. Peut être “hour”, “day”, “week”, “month” ou “cumulative”.

Valeurs autorisées:
aggregation_bucket_sizeinteger or nullOptionnel

Taille de l’intervalle d’agrégation en secondes. Remplace l’intervalle d’agrégation.

metricenumOptionnel

Indique la métrique à agréger.

Réponse

Réponse réussie

timelist of integers

L’axe temporel avec les horodatages Unix de chaque jour.

usagemap from strings to lists of doubles

L’utilisation de chaque type de répartition sur l’axe temporel.

Erreurs

422
Unprocessable Entity Error