Class UsageAnalyticsGetParams
-
- All Implemented Interfaces:
-
io.imagekit.core.Params
public final class UsageAnalyticsGetParams implements 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUsageAnalyticsGetParams.BuilderA builder for UsageAnalyticsGetParams.
-
Method Summary
Modifier and Type Method Description final LocalDateendDate()Specify an endDateinYYYY-MM-DDformat, interpreted as a UTC calendar day.final LocalDatestartDate()Specify a startDateinYYYY-MM-DDformat, interpreted as a UTC calendar day.final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final UsageAnalyticsGetParams.BuildertoBuilder()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static UsageAnalyticsGetParams.Builderbuilder()Returns a mutable builder for constructing an instance of UsageAnalyticsGetParams. -
-
Method Detail
-
endDate
final LocalDate endDate()
Specify an
endDateinYYYY-MM-DDformat, interpreted as a UTC calendar day. It should be after thestartDate. The difference betweenstartDateandendDateshould be less than 90 days.
-
startDate
final LocalDate startDate()
Specify a
startDateinYYYY-MM-DDformat, interpreted as a UTC calendar day. It should be before theendDate. The difference betweenstartDateandendDateshould be less than 90 days.
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final UsageAnalyticsGetParams.Builder toBuilder()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static UsageAnalyticsGetParams.Builder builder()
Returns a mutable builder for constructing an instance of UsageAnalyticsGetParams.
The following fields are required:
.endDate() .startDate()
-
-
-
-