Package com.seeq.api

Class UsageApi

java.lang.Object
com.seeq.api.UsageApi

public class UsageApi extends Object
  • Constructor Details

    • UsageApi

      public UsageApi()
    • UsageApi

      public UsageApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • getTypes

      public UsageTypesV1 getTypes() throws ApiException
      Get the list of available types that can be used as filter values for the reporting endpoint
      Returns:
      UsageTypesV1
      Throws:
      ApiException - if fails to make API call
    • getTypesWithHttpInfo

      public ApiClient.ApiResponse<UsageTypesV1> getTypesWithHttpInfo() throws ApiException
      Get the list of available types that can be used as filter values for the reporting endpoint
      Throws:
      ApiException - if fails to make API call
    • getTypesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UsageTypesV1> getTypesWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Get the list of available types that can be used as filter values for the reporting endpoint
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getUsage

      public UsageOutputListV1 getUsage(String startTime, String endTime, List<String> type, String source, String unit, List<String> identityId, List<String> aggregateBy) throws ApiException
      Get usage records for the specified time range. Results will be sorted by date if aggregating by day or month, otherwise by amount descending and limited to the first 500 records
      Parameters:
      startTime - Start time for the time frame (YYYY-MM-DDThh:mm:ss±hh:mm) (required)
      endTime - End time for the time frame (YYYY-MM-DDThh:mm:ss±hh:mm) (required)
      type - Filter by type of usage (e.g. Analysis, Screenshot) (optional)
      source - Filter by any part of the origin label or origin url fields (optional)
      unit - Filter by the unit that the usage is measured in (e.g. Bytes, Credits, Any). Default is Bytes. (optional, default to Bytes)
      identityId - Filter by the UUID of the user who initiated the request (optional)
      aggregateBy - Aggregate the usage records by one or more fields. Cannot aggregate by both Day and Month at the same time. (optional)
      Returns:
      UsageOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getUsageWithHttpInfo

      public ApiClient.ApiResponse<UsageOutputListV1> getUsageWithHttpInfo(String startTime, String endTime, List<String> type, String source, String unit, List<String> identityId, List<String> aggregateBy) throws ApiException
      Get usage records for the specified time range. Results will be sorted by date if aggregating by day or month, otherwise by amount descending and limited to the first 500 records
      Parameters:
      startTime - Start time for the time frame (YYYY-MM-DDThh:mm:ss±hh:mm) (required)
      endTime - End time for the time frame (YYYY-MM-DDThh:mm:ss±hh:mm) (required)
      type - Filter by type of usage (e.g. Analysis, Screenshot) (optional)
      source - Filter by any part of the origin label or origin url fields (optional)
      unit - Filter by the unit that the usage is measured in (e.g. Bytes, Credits, Any). Default is Bytes. (optional, default to Bytes)
      identityId - Filter by the UUID of the user who initiated the request (optional)
      aggregateBy - Aggregate the usage records by one or more fields. Cannot aggregate by both Day and Month at the same time. (optional)
      Throws:
      ApiException - if fails to make API call
    • getUsageWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UsageOutputListV1> getUsageWithHeadersAndHttpInfo(String startTime, String endTime, List<String> type, String source, String unit, List<String> identityId, List<String> aggregateBy, Map<String,String> customHeaders) throws ApiException
      Get usage records for the specified time range. Results will be sorted by date if aggregating by day or month, otherwise by amount descending and limited to the first 500 records
      Parameters:
      startTime - Start time for the time frame (YYYY-MM-DDThh:mm:ss±hh:mm) (required)
      endTime - End time for the time frame (YYYY-MM-DDThh:mm:ss±hh:mm) (required)
      type - Filter by type of usage (e.g. Analysis, Screenshot) (optional)
      source - Filter by any part of the origin label or origin url fields (optional)
      unit - Filter by the unit that the usage is measured in (e.g. Bytes, Credits, Any). Default is Bytes. (optional, default to Bytes)
      identityId - Filter by the UUID of the user who initiated the request (optional)
      aggregateBy - Aggregate the usage records by one or more fields. Cannot aggregate by both Day and Month at the same time. (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call