Class StatsApi

java.lang.Object
sendpost_java_sdk.StatsApi
public class StatsApi extends Object

  • Constructor Details

    • StatsApi

      public StatsApi()

    • StatsApi

      public StatsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • accountSubaccountStatSubaccountIdAggregateGetCall

      public okhttp3.Call accountSubaccountStatSubaccountIdAggregateGetCall(@Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId, ApiCallback _callback) throws ApiException
      Build call for accountSubaccountStatSubaccountIdAggregateGet
      Parameters:
      from - Start date for stats retrieval. (required)
      to - Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response -

    • accountSubaccountStatSubaccountIdAggregateGet

      public AggregateStat accountSubaccountStatSubaccountIdAggregateGet(@Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId) throws ApiException
      Get Aggregate Stats Retrieves aggregated email stats for a specific sub-account for a date range. **Note**: The maximum date range is 366 days.
      Parameters:
      from - Start date for stats retrieval. (required)
      to - Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      Returns:
      AggregateStat
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response -

    • accountSubaccountStatSubaccountIdAggregateGetWithHttpInfo

      public ApiResponse<AggregateStat> accountSubaccountStatSubaccountIdAggregateGetWithHttpInfo(@Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId) throws ApiException
      Get Aggregate Stats Retrieves aggregated email stats for a specific sub-account for a date range. **Note**: The maximum date range is 366 days.
      Parameters:
      from - Start date for stats retrieval. (required)
      to - Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      Returns:
      ApiResponse<AggregateStat>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response -

    • accountSubaccountStatSubaccountIdAggregateGetAsync

      public okhttp3.Call accountSubaccountStatSubaccountIdAggregateGetAsync(@Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId, ApiCallback<AggregateStat> _callback) throws ApiException
      Get Aggregate Stats (asynchronously) Retrieves aggregated email stats for a specific sub-account for a date range. **Note**: The maximum date range is 366 days.
      Parameters:
      from - Start date for stats retrieval. (required)
      to - Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response -

    • accountSubaccountStatSubaccountIdGetCall

      public okhttp3.Call accountSubaccountStatSubaccountIdGetCall(@Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId, ApiCallback _callback) throws ApiException
      Build call for accountSubaccountStatSubaccountIdGet
      Parameters:
      from - Start date for stats retrieval. (required)
      to - Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response -

    • accountSubaccountStatSubaccountIdGet

      public List<Stat> accountSubaccountStatSubaccountIdGet(@Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId) throws ApiException
      Get All Stats Retrieves a list of email stats for a specific sub-account within a given date range. Both `from` and `to` dates are inclusive. **Note**: The maximum date range is 31 days.
      Parameters:
      from - Start date for stats retrieval. (required)
      to - Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      Returns:
      List<Stat>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response -

    • accountSubaccountStatSubaccountIdGetWithHttpInfo

      public ApiResponse<List<Stat>> accountSubaccountStatSubaccountIdGetWithHttpInfo(@Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId) throws ApiException
      Get All Stats Retrieves a list of email stats for a specific sub-account within a given date range. Both `from` and `to` dates are inclusive. **Note**: The maximum date range is 31 days.
      Parameters:
      from - Start date for stats retrieval. (required)
      to - Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      Returns:
      ApiResponse<List<Stat>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response -

    • accountSubaccountStatSubaccountIdGetAsync

      public okhttp3.Call accountSubaccountStatSubaccountIdGetAsync(@Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId, ApiCallback<List<Stat>> _callback) throws ApiException
      Get All Stats (asynchronously) Retrieves a list of email stats for a specific sub-account within a given date range. Both `from` and `to` dates are inclusive. **Note**: The maximum date range is 31 days.
      Parameters:
      from - Start date for stats retrieval. (required)
      to - Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Successful response -

    • getAggregateStatsByGroupCall

      public okhttp3.Call getAggregateStatsByGroupCall(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId, ApiCallback _callback) throws ApiException
      Build call for getAggregateStatsByGroup
      Parameters:
      group - Group whose aggregated stats need to be retrieved (required)
      from - The starting date for the aggregated stats (required)
      to - The ending date for the aggregated stats (Note: `from` should be earlier than `to` and the date range should not exceed 366 days) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Aggregated email stats for the group within the specified date range -

    • getAggregateStatsByGroup

      public AggregateStat getAggregateStatsByGroup(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId) throws ApiException
      Get aggregated stats by group Retrieves aggregated email stats for a specific group in a sub-account for the specified daterange. The maximum daterange for which these stats can be retrieved is 366 days. Ensure that the difference between the `from` and `to` dates does not exceed 366 days.
      Parameters:
      group - Group whose aggregated stats need to be retrieved (required)
      from - The starting date for the aggregated stats (required)
      to - The ending date for the aggregated stats (Note: `from` should be earlier than `to` and the date range should not exceed 366 days) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      Returns:
      AggregateStat
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Aggregated email stats for the group within the specified date range -

    • getAggregateStatsByGroupWithHttpInfo

      public ApiResponse<AggregateStat> getAggregateStatsByGroupWithHttpInfo(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId) throws ApiException
      Get aggregated stats by group Retrieves aggregated email stats for a specific group in a sub-account for the specified daterange. The maximum daterange for which these stats can be retrieved is 366 days. Ensure that the difference between the `from` and `to` dates does not exceed 366 days.
      Parameters:
      group - Group whose aggregated stats need to be retrieved (required)
      from - The starting date for the aggregated stats (required)
      to - The ending date for the aggregated stats (Note: `from` should be earlier than `to` and the date range should not exceed 366 days) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      Returns:
      ApiResponse<AggregateStat>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Aggregated email stats for the group within the specified date range -

    • getAggregateStatsByGroupAsync

      public okhttp3.Call getAggregateStatsByGroupAsync(@Nonnull String group, @Nonnull LocalDate from, @Nonnull LocalDate to, @Nonnull Long subaccountId, ApiCallback<AggregateStat> _callback) throws ApiException
      Get aggregated stats by group (asynchronously) Retrieves aggregated email stats for a specific group in a sub-account for the specified daterange. The maximum daterange for which these stats can be retrieved is 366 days. Ensure that the difference between the `from` and `to` dates does not exceed 366 days.
      Parameters:
      group - Group whose aggregated stats need to be retrieved (required)
      from - The starting date for the aggregated stats (required)
      to - The ending date for the aggregated stats (Note: `from` should be earlier than `to` and the date range should not exceed 366 days) (required)
      subaccountId - The ID of the subaccount to retrieve (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Response Details
      Status Code Description Response Headers
      200 Aggregated email stats for the group within the specified date range -