Hoppa till navigering

Hämta användningsstatistik för tecken

Deprecated

(Föråldrat) Den här slutpunkten är föråldrad. Använd i stället /v1/workspace/analytics/query/usage-by-product-over-time, som exponerar bucketstorleken som interval_seconds (ett heltal i sekunder) i stället för aggregation_interval. Returnerar användningsstatistik för den aktuella användaren eller hela arbetsytan som användaren tillhör. Svaret innehåller en tidsaxel baserad på det angivna aggregeringsintervallet (standard: dag), med användningsvärden för varje intervall längs axeln. Användningen delas upp efter vald uppdelningstyp. Uppdelningstypen “voice” returnerar till exempel användningen för varje röst i varje intervall längs tidsaxeln.

Headers

xi-api-keystringValfri

Frågeparametrar

start_unixintegerObligatorisk

UTC Unix-tidsstämpel för början av användningsintervallet, i millisekunder. För att inkludera intervallets första dag ska tidsstämpeln vara 00:00:00 den dagen.

end_unixintegerObligatorisk

UTC Unix-tidsstämpel för slutet av användningsintervallet, i millisekunder. För att inkludera intervallets sista dag ska tidsstämpeln vara 23:59:59 den dagen.

include_workspace_metricsbooleanValfriStandard är false

Om statistik för hela arbetsytan ska inkluderas.

breakdown_typeenumValfri

Hur informationen ska delas upp. Kan inte vara "user" om include_workspace_metrics är False.

aggregation_intervalenumValfri

Hur användningsdata ska aggregeras över tid. Kan vara "hour", "day", "week", "month" eller "cumulative".

Tillåtna värden:
aggregation_bucket_sizeinteger or nullValfri

Storlek på aggregeringsintervall i sekunder. Åsidosätter aggregeringsintervallet.

metricenumValfri

Vilket mätvärde som ska aggregeras.

Svar

Lyckat svar
timelist of integers

Tidsaxeln med Unix-tidsstämplar för varje dag.

usagemap from strings to lists of doubles

Användningen för varje uppdelningstyp längs tidsaxeln.

Fel

422
Unprocessable Entity Error