Naar navigatie springen
VerouderdGebruik

Gebruiksstatistieken voor tekens ophalen

Deprecated

(Verouderd) Dit endpoint is verouderd. Gebruik in plaats daarvan /v1/workspace/analytics/query/usage-by-product-over-time, dat de bucketgrootte weergeeft als interval_seconds (een geheel getal in seconden) in plaats van aggregation_interval. Retourneert de gebruiksstatistieken voor de huidige gebruiker of de volledige workspace waartoe deze behoort. Het antwoord bevat een tijdas op basis van het opgegeven aggregatie-interval (standaard: dag), met gebruikswaarden voor elk interval op die as. Het gebruik wordt uitgesplitst volgens het geselecteerde type uitsplitsing. Zo retourneert uitsplitsingstype “voice” het gebruik van elke stem voor elk interval op de tijdas.

Headers

xi-api-keystringOptioneel

Queryparameters

start_unixintegerVerplicht

UTC Unix-timestamp voor het begin van het gebruiksvenster, in milliseconden. Om de eerste dag van het venster op te nemen, moet de timestamp op 00:00:00 van die dag staan.

end_unixintegerVerplicht

UTC Unix-timestamp voor het einde van het gebruiksvenster, in milliseconden. Om de laatste dag van het venster op te nemen, moet de timestamp op 23:59:59 van die dag staan.

include_workspace_metricsbooleanOptioneelStandaard false
Of de statistieken van de hele workspace moeten worden opgenomen.
breakdown_typeenumOptioneel

Hoe de informatie moet worden uitgesplitst. Kan niet “user” zijn als include_workspace_metrics False is.

aggregation_intervalenumOptioneel
Hoe gebruiksgegevens in de tijd moeten worden geaggregeerd. Kan "hour", "day", "week", "month" of "cumulative" zijn.
Toegestane waarden:
aggregation_bucket_sizeinteger or nullOptioneel

Grootte van de aggregatiebucket in seconden. Overschrijft het aggregatie-interval.

metricenumOptioneel
Welke metriek moet worden geaggregeerd.

Response

Geslaagde response
timelist of integers

De tijdas met Unix-timestamps voor elke dag.

usagemap from strings to lists of doubles
Het gebruik van elk uitsplitsingstype langs de tijdas.

Fouten

422
Unprocessable Entity Error