Interface UsageAnalyticsService
-
- All Implemented Interfaces:
public interface UsageAnalyticsService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceUsageAnalyticsService.WithRawResponseA view of UsageAnalyticsService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract UsageAnalyticsService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract UsageAnalyticsServicewithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. UsageAnalyticsResponseget(UsageAnalyticsGetParams params)Note: This API is currently in beta. abstract UsageAnalyticsResponseget(UsageAnalyticsGetParams params, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract UsageAnalyticsService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract UsageAnalyticsService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
get
UsageAnalyticsResponse get(UsageAnalyticsGetParams params)
Note: This API is currently in beta.
Get the account analytics data between two dates. The response covers the period from the start date to the end date, both dates inclusive. Both dates are interpreted as UTC calendar days.
The returned data is scoped to the requesting account only. Unlike
/v1/accounts/usage, an agency account's analytics are not aggregated across its child accounts.The response is cached for 5 minutes per account and date range. Use
generatedAtto check how fresh the returned data is.
-
get
abstract UsageAnalyticsResponse get(UsageAnalyticsGetParams params, RequestOptions requestOptions)
-
-
-
-