Package com.growsurf.api.models.campaign
Class CampaignRetrieveAnalyticsParams
-
- All Implemented Interfaces:
-
com.growsurf.api.core.Params
public final class CampaignRetrieveAnalyticsParams implements Params
Retrieves analytics for a program.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCampaignRetrieveAnalyticsParams.BuilderA builder for CampaignRetrieveAnalyticsParams.
-
Method Summary
Modifier and Type Method Description final Optional<String>id()final Optional<Long>days()Last number of days to retrieve analytics for. final Optional<Long>endDate()End date of the analytics timeframe as a Unix timestamp in milliseconds. final Optional<Long>startDate()Start date of the analytics timeframe as a Unix timestamp in milliseconds. final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final CampaignRetrieveAnalyticsParams.BuildertoBuilder()final String_pathParam(Integer index)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 CampaignRetrieveAnalyticsParamsnone()final static CampaignRetrieveAnalyticsParams.Builderbuilder()Returns a mutable builder for constructing an instance of CampaignRetrieveAnalyticsParams. -
-
Method Detail
-
days
final Optional<Long> days()
Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
-
endDate
final Optional<Long> endDate()
End date of the analytics timeframe as a Unix timestamp in milliseconds. Required if
daysis not set.
-
startDate
final Optional<Long> startDate()
Start date of the analytics timeframe as a Unix timestamp in milliseconds. Required if
daysis not set.
-
_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 CampaignRetrieveAnalyticsParams.Builder toBuilder()
-
_pathParam
final String _pathParam(Integer index)
-
_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.
-
none
final static CampaignRetrieveAnalyticsParams none()
-
builder
final static CampaignRetrieveAnalyticsParams.Builder builder()
Returns a mutable builder for constructing an instance of CampaignRetrieveAnalyticsParams.
-
-
-
-