LegacyUsage

Zeichennutzungsmetriken abrufen

Deprecated
(Veraltet) Dieser Endpunkt ist veraltet. Verwenden Sie stattdessen /v1/workspace/analytics/query/usage-by-product-over-time. Dort wird die Bucket-Größe als `interval_seconds` (eine Ganzzahl in Sekunden) statt als `aggregation_interval` angegeben. Gibt die Nutzungsmetriken für den aktuellen Benutzer oder den gesamten Workspace zurück, zu dem er gehört. Die Antwort enthält eine Zeitachse basierend auf dem angegebenen Aggregationsintervall (Standard: Tag) mit Nutzungswerten für jedes Intervall. Die Nutzung wird nach dem ausgewählten Aufschlüsselungstyp gegliedert. Der Aufschlüsselungstyp "voice" gibt beispielsweise die Nutzung jeder Stimme für jedes Intervall entlang der Zeitachse zurück.

Header

xi-api-keystringOptional

Abfrageparameter

start_unixintegerErforderlich

UTC-Unix-Zeitstempel für den Beginn des Nutzungszeitraums in Millisekunden. Um den ersten Tag des Zeitraums einzuschließen, sollte der Zeitstempel auf 00:00:00 dieses Tages gesetzt sein.

end_unixintegerErforderlich

UTC-Unix-Zeitstempel für das Ende des Nutzungszeitraums in Millisekunden. Um den letzten Tag des Zeitraums einzuschließen, sollte der Zeitstempel auf 23:59:59 dieses Tages gesetzt sein.

include_workspace_metricsbooleanOptionalStandardwert ist false
Gibt an, ob die Statistiken des gesamten Workspace einbezogen werden sollen.
breakdown_typeenumOptional

Wie die Informationen aufgeschlüsselt werden sollen. Darf nicht “user” sein, wenn include_workspace_metrics False ist.

aggregation_intervalenumOptional

Wie Nutzungsdaten über die Zeit aggregiert werden sollen. Möglich sind “hour”, “day”, “week”, “month” oder “cumulative”.

Erlaubte Werte:
aggregation_bucket_sizeinteger or nullOptional

Größe des Aggregations-Buckets in Sekunden. Überschreibt das Aggregationsintervall.

metricenumOptional
Welche Metrik aggregiert werden soll.

Antwort

Erfolgreiche Antwort
timelist of integers

Die Zeitachse mit Unix-Zeitstempeln für jeden Tag.

usagemap from strings to lists of doubles

Die Nutzung jedes Aufschlüsselungstyps entlang der Zeitachse.

Fehler

422
Unprocessable Entity Error