Przejdź do nawigacji
Starsze wersjeUżycie

Pobierz statystyki użycia znaków

Deprecated

(Wycofane) Ten endpoint jest wycofany. Zamiast niego użyj /v1/workspace/analytics/query/usage-by-product-over-time, który udostępnia rozmiar przedziału jako interval_seconds (liczbę całkowitą w sekundach), a nie aggregation_interval. Zwraca dane o użyciu dla bieżącego użytkownika lub całego workspace, do którego należy. Odpowiedź zawiera oś czasu opartą na wybranym interwale agregacji (domyślnie: dzień) z wartościami użycia dla każdego przedziału. Użycie jest podzielone według wybranego typu podziału. Na przykład typ podziału “voice” zwróci użycie każdego głosu dla każdego przedziału na osi czasu.

Nagłówki

xi-api-keystringOpcjonalny

Parametry zapytania

start_unixintegerWymagany

Znacznik czasu Unix UTC początku okresu użycia, w milisekundach. Aby uwzględnić pierwszy dzień okresu, znacznik czasu powinien wskazywać 00:00:00 tego dnia.

end_unixintegerWymagany

Znacznik czasu Unix UTC końca okresu użycia, w milisekundach. Aby uwzględnić ostatni dzień okresu, znacznik czasu powinien wskazywać 23:59:59 tego dnia.

include_workspace_metricsbooleanOpcjonalnyDomyślnie false

Czy uwzględniać statystyki całego obszaru roboczego.

breakdown_typeenumOpcjonalny

Jak podzielić informacje. Nie może mieć wartości „user”, jeśli include_workspace_metrics ma wartość False.

aggregation_intervalenumOpcjonalny

Jak agregować dane o użyciu w czasie. Może to być „hour”, „day”, „week”, „month” lub „cumulative”.

Dozwolone wartości:
aggregation_bucket_sizeinteger or nullOpcjonalny

Rozmiar przedziału agregacji w sekundach. Zastępuje interwał agregacji.

metricenumOpcjonalny

Którą metrykę agregować.

Odpowiedź

Pomyślna odpowiedź

timelist of integers

Oś czasu ze znacznikami czasu Unix dla każdego dnia.

usagemap from strings to lists of doubles

Użycie każdego typu podziału na osi czasu.

Błędy

422
Unprocessable Entity Error