Class: LaunchDarklyApi::AccountUsageBetaApi

#get_contexts_clientside_usage(opts = {}) ⇒ `SeriesListRep`

Get contexts clientside usage Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints. The counts reflect data reported by client-side SDKs. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:context_kind (String) —

A context kind to filter results by. Can be specified multiple times, one query parameter per context kind.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. `contextKind` is always included as a grouping dimension. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 36

def get_contexts_clientside_usage(opts = {})
  data, _status_code, _headers = get_contexts_clientside_usage_with_http_info(opts)
  data
end

#get_contexts_clientside_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get contexts clientside usage Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints. The counts reflect data reported by client-side SDKs. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:context_kind (String) —

A context kind to filter results by. Can be specified multiple times, one query parameter per context kind.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. `contextKind` is always included as a grouping dimension. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 55

def get_contexts_clientside_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_contexts_clientside_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/clientside-contexts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'contextKind'] = opts[:'context_kind'] if !opts[:'context_kind'].nil?
  query_params[:'sdkName'] = opts[:'sdk_name'] if !opts[:'sdk_name'].nil?
  query_params[:'anonymous'] = opts[:'anonymous'] if !opts[:'anonymous'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_contexts_clientside_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_contexts_clientside_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contexts_serverside_usage(opts = {}) ⇒ `SeriesListRep`

Get contexts serverside usage Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints. The counts reflect data reported by server-side SDKs. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:context_kind (String) —

A context kind to filter results by. Can be specified multiple times, one query parameter per context kind.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. `contextKind` is always included as a grouping dimension. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 123

def get_contexts_serverside_usage(opts = {})
  data, _status_code, _headers = get_contexts_serverside_usage_with_http_info(opts)
  data
end

#get_contexts_serverside_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get contexts serverside usage Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints. The counts reflect data reported by server-side SDKs. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:context_kind (String) —

A context kind to filter results by. Can be specified multiple times, one query parameter per context kind.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. `contextKind` is always included as a grouping dimension. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 142

def get_contexts_serverside_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_contexts_serverside_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/serverside-contexts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'contextKind'] = opts[:'context_kind'] if !opts[:'context_kind'].nil?
  query_params[:'sdkName'] = opts[:'sdk_name'] if !opts[:'sdk_name'].nil?
  query_params[:'anonymous'] = opts[:'anonymous'] if !opts[:'anonymous'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_contexts_serverside_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_contexts_serverside_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contexts_total_usage(opts = {}) ⇒ `SeriesListRep`

Get contexts total usage Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:context_kind (String) —

A context kind to filter results by. Can be specified multiple times, one query parameter per context kind.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:sdk_type (String) —

An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. `contextKind` is always included as a grouping dimension. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 211

def get_contexts_total_usage(opts = {})
  data, _status_code, _headers = get_contexts_total_usage_with_http_info(opts)
  data
end

#get_contexts_total_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get contexts total usage Get a detailed time series of the number of context key usages observed by LaunchDarkly in your account, including non-primary context kinds. Use this for breakdowns that go beyond the primary-only aggregation of MAU endpoints. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:context_kind (String) —

A context kind to filter results by. Can be specified multiple times, one query parameter per context kind.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:sdk_type (String) —

An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. `contextKind` is always included as a grouping dimension. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 231

def get_contexts_total_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_contexts_total_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/total-contexts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'contextKind'] = opts[:'context_kind'] if !opts[:'context_kind'].nil?
  query_params[:'sdkName'] = opts[:'sdk_name'] if !opts[:'sdk_name'].nil?
  query_params[:'sdkType'] = opts[:'sdk_type'] if !opts[:'sdk_type'].nil?
  query_params[:'anonymous'] = opts[:'anonymous'] if !opts[:'anonymous'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_contexts_total_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_contexts_total_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_data_export_events_usage(opts = {}) ⇒ `SeriesListRep`

Get data export events usage Get a time series array showing the number of data export events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:event_kind (String) —

An event kind to filter results by. Can be specified multiple times, one query parameter per event kind.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `environmentId`, `eventKind`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. `monthly` granularity is only supported with the month_to_date aggregation type. Valid values: `daily`, `hourly`, `monthly`.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 298

def get_data_export_events_usage(opts = {})
  data, _status_code, _headers = get_data_export_events_usage_with_http_info(opts)
  data
end

#get_data_export_events_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get data export events usage Get a time series array showing the number of data export events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:event_kind (String) —

An event kind to filter results by. Can be specified multiple times, one query parameter per event kind.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `environmentId`, `eventKind`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. `monthly` granularity is only supported with the month_to_date aggregation type. Valid values: `daily`, `hourly`, `monthly`.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 315

def get_data_export_events_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_data_export_events_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/data-export-events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'eventKind'] = opts[:'event_kind'] if !opts[:'event_kind'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_data_export_events_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_data_export_events_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_evaluations_usage(project_key, environment_key, feature_flag_key, opts = {}) ⇒ `SeriesListRep`

Get evaluations usage Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.

Parameters:

project_key (String) —

The project key
environment_key (String) —

The environment key
feature_flag_key (String) —

The feature flag key
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 30 days ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.
:tz (String) —

The timezone to use for breaks between days when returning daily data.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 377

def get_evaluations_usage(project_key, environment_key, feature_flag_key, opts = {})
  data, _status_code, _headers = get_evaluations_usage_with_http_info(project_key, environment_key, feature_flag_key, opts)
  data
end

#get_evaluations_usage_with_http_info(project_key, environment_key, feature_flag_key, opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get evaluations usage Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.

Parameters:

project_key (String) —

The project key
environment_key (String) —

The environment key
feature_flag_key (String) —

The feature flag key
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 30 days ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.
:tz (String) —

The timezone to use for breaks between days when returning daily data.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 392

def get_evaluations_usage_with_http_info(project_key, environment_key, feature_flag_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_evaluations_usage ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling AccountUsageBetaApi.get_evaluations_usage"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling AccountUsageBetaApi.get_evaluations_usage"
  end
  # verify the required parameter 'feature_flag_key' is set
  if @api_client.config.client_side_validation && feature_flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling AccountUsageBetaApi.get_evaluations_usage"
  end
  # resource path
  local_var_path = '/api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'tz'] = opts[:'tz'] if !opts[:'tz'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_evaluations_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_evaluations_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_events_usage(type, opts = {}) ⇒ `SeriesListRep`

Get events usage Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.

Parameters:

type (String) —

The type of event to retrieve. Must be either `received` or `published`.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 24 hours ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 458

def get_events_usage(type, opts = {})
  data, _status_code, _headers = get_events_usage_with_http_info(type, opts)
  data
end

#get_events_usage_with_http_info(type, opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get events usage Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.

Parameters:

type (String) —

The type of event to retrieve. Must be either `received` or `published`.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 24 hours ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 470

def get_events_usage_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_events_usage ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling AccountUsageBetaApi.get_events_usage"
  end
  # resource path
  local_var_path = '/api/v2/usage/events/{type}'.sub('{' + 'type' + '}', CGI.escape(type.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_events_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_events_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_experimentation_events_usage(opts = {}) ⇒ `SeriesListRep`

Get experimentation events usage Get a time series array showing the number of experimentation events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:event_key (String) —

An event key to filter results by. Can be specified multiple times, one query parameter per event key.
:event_kind (String) —

An event kind to filter results by. Can be specified multiple times, one query parameter per event kind.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `environmentId`, `eventKey`, `eventKind`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. `monthly` granularity is only supported with the month_to_date aggregation type. Valid values: `daily`, `hourly`, `monthly`.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 533

def get_experimentation_events_usage(opts = {})
  data, _status_code, _headers = get_experimentation_events_usage_with_http_info(opts)
  data
end

#get_experimentation_events_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get experimentation events usage Get a time series array showing the number of experimentation events from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:event_key (String) —

An event key to filter results by. Can be specified multiple times, one query parameter per event key.
:event_kind (String) —

An event kind to filter results by. Can be specified multiple times, one query parameter per event kind.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `environmentId`, `eventKey`, `eventKind`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. `monthly` granularity is only supported with the month_to_date aggregation type. Valid values: `daily`, `hourly`, `monthly`.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 551

def get_experimentation_events_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_experimentation_events_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/experimentation-events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'eventKey'] = opts[:'event_key'] if !opts[:'event_key'].nil?
  query_params[:'eventKind'] = opts[:'event_kind'] if !opts[:'event_kind'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_experimentation_events_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_experimentation_events_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_experimentation_keys_usage(opts = {}) ⇒ `SeriesListRep`

Get experimentation keys usage Get a time series array showing the number of experimentation keys from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:experiment_id (String) —

An experiment ID to filter results by. Can be specified multiple times, one query parameter per experiment ID.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `experimentId`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. `monthly` granularity is only supported with the month_to_date aggregation type. Valid values: `daily`, `hourly`, `monthly`.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 616

def get_experimentation_keys_usage(opts = {})
  data, _status_code, _headers = get_experimentation_keys_usage_with_http_info(opts)
  data
end

#get_experimentation_keys_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get experimentation keys usage Get a time series array showing the number of experimentation keys from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:experiment_id (String) —

An experiment ID to filter results by. Can be specified multiple times, one query parameter per experiment ID.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `experimentId`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. `monthly` granularity is only supported with the month_to_date aggregation type. Valid values: `daily`, `hourly`, `monthly`.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 633

def get_experimentation_keys_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_experimentation_keys_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/experimentation-keys'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'experimentId'] = opts[:'experiment_id'] if !opts[:'experiment_id'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_experimentation_keys_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_experimentation_keys_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mau_clientside_usage(opts = {}) ⇒ `SeriesListRep`

Get MAU clientside usage Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. The counts reflect data reported from client-side SDKs. For past months, the primary context kind is fixed and reflects the last known primary kind for that month. For the current month, it may vary as new primary context kinds are observed. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 698

def get_mau_clientside_usage(opts = {})
  data, _status_code, _headers = get_mau_clientside_usage_with_http_info(opts)
  data
end

#get_mau_clientside_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get MAU clientside usage Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. The counts reflect data reported from client-side SDKs. For past months, the primary context kind is fixed and reflects the last known primary kind for that month. For the current month, it may vary as new primary context kinds are observed. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 716

def get_mau_clientside_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_mau_clientside_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/clientside-mau'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'sdkName'] = opts[:'sdk_name'] if !opts[:'sdk_name'].nil?
  query_params[:'anonymous'] = opts[:'anonymous'] if !opts[:'anonymous'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_mau_clientside_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_mau_clientside_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mau_sdks_by_type(opts = {}) ⇒ `SdkListRep`

Get MAU SDKs by type Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period. Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](launchdarkly.com/docs/home/account/metrics).

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000.
:to (String) —

The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000.
:sdktype (String) —

The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`.

Returns:

(SdkListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 776

def get_mau_sdks_by_type(opts = {})
  data, _status_code, _headers = get_mau_sdks_by_type_with_http_info(opts)
  data
end

#get_mau_sdks_by_type_with_http_info(opts = {}) ⇒ `Array<(SdkListRep, Integer, Hash)>`

Get MAU SDKs by type Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period. Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](launchdarkly.com/docs/home/account/metrics).

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The data returned starts from this timestamp. Defaults to seven days ago. The timestamp is in Unix milliseconds, for example, 1656694800000.
:to (String) —

The data returned ends at this timestamp. Defaults to the current time. The timestamp is in Unix milliseconds, for example, 1657904400000.
:sdktype (String) —

The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`.

Returns:

(Array<(SdkListRep, Integer, Hash)>) —

SdkListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 788

def get_mau_sdks_by_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_mau_sdks_by_type ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/mau/sdks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'sdktype'] = opts[:'sdktype'] if !opts[:'sdktype'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SdkListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_mau_sdks_by_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_mau_sdks_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mau_total_usage(opts = {}) ⇒ `SeriesListRep`

Get MAU total usage Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. For past months, this reflects the context kind that was most recently marked as primary for that month. For the current month, the context kind may vary as new primary kinds are observed. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:sdk_type (String) —

An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 849

def get_mau_total_usage(opts = {})
  data, _status_code, _headers = get_mau_total_usage_with_http_info(opts)
  data
end

#get_mau_total_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get MAU total usage Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. For past months, this reflects the context kind that was most recently marked as primary for that month. For the current month, the context kind may vary as new primary kinds are observed. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:sdk_type (String) —

An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
:anonymous (String) —

An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value. Valid values: `true`, `false`.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 868

def get_mau_total_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_mau_total_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/total-mau'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'sdkName'] = opts[:'sdk_name'] if !opts[:'sdk_name'].nil?
  query_params[:'sdkType'] = opts[:'sdk_type'] if !opts[:'sdk_type'].nil?
  query_params[:'anonymous'] = opts[:'anonymous'] if !opts[:'anonymous'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_mau_total_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_mau_total_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mau_usage(opts = {}) ⇒ `SeriesListRep`

Get MAU usage Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily. Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](launchdarkly.com/docs/home/account/metrics).

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 30 days ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.
:project (String) —

A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects.
:environment (String) —

An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project.
:sdktype (String) —

An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server
:sdk (String) —

An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK.
:anonymous (String) —

If specified, filters results to either anonymous or nonanonymous users.
:groupby (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous, contextKind, sdkAppId
:aggregation_type (String) —

If specified, queries for rolling 30-day, month-to-date, or daily incremental counts. Default is rolling 30-day. Valid values: rolling_30d, month_to_date, daily_incremental
:context_kind (String) —

Filters results to the specified context kinds. Can be specified multiple times, one query parameter per context kind. If not set, queries for the user context kind.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 936

def get_mau_usage(opts = {})
  data, _status_code, _headers = get_mau_usage_with_http_info(opts)
  data
end

#get_mau_usage_by_category(opts = {}) ⇒ `SeriesListRep`

Get MAU usage by category Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either ‘browser`, `mobile`, or `backend`. Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](launchdarkly.com/docs/home/account/metrics).

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 30 days ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1015

def get_mau_usage_by_category(opts = {})
  data, _status_code, _headers = get_mau_usage_by_category_with_http_info(opts)
  data
end

#get_mau_usage_by_category_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get MAU usage by category Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`. Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](launchdarkly.com/docs/home/account/metrics).

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 30 days ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1026

def get_mau_usage_by_category_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_mau_usage_by_category ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/mau/bycategory'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_mau_usage_by_category",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_mau_usage_by_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mau_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get MAU usage Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily. Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. To learn more, read [Account usage metrics](launchdarkly.com/docs/home/account/metrics).

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 30 days ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.
:project (String) —

A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects.
:environment (String) —

An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project.
:sdktype (String) —

An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server
:sdk (String) —

An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK.
:anonymous (String) —

If specified, filters results to either anonymous or nonanonymous users.
:groupby (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous, contextKind, sdkAppId
:aggregation_type (String) —

If specified, queries for rolling 30-day, month-to-date, or daily incremental counts. Default is rolling 30-day. Valid values: rolling_30d, month_to_date, daily_incremental
:context_kind (String) —

Filters results to the specified context kinds. Can be specified multiple times, one query parameter per context kind. If not set, queries for the user context kind.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 955

def get_mau_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_mau_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/mau'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'project'] = opts[:'project'] if !opts[:'project'].nil?
  query_params[:'environment'] = opts[:'environment'] if !opts[:'environment'].nil?
  query_params[:'sdktype'] = opts[:'sdktype'] if !opts[:'sdktype'].nil?
  query_params[:'sdk'] = opts[:'sdk'] if !opts[:'sdk'].nil?
  query_params[:'anonymous'] = opts[:'anonymous'] if !opts[:'anonymous'].nil?
  query_params[:'groupby'] = opts[:'groupby'] if !opts[:'groupby'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'contextKind'] = opts[:'context_kind'] if !opts[:'context_kind'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_mau_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_mau_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_observability_errors_usage(opts = {}) ⇒ `SeriesListRep`

Get observability errors usage Get time-series arrays of the number of observability errors. Supports ‘daily` and `monthly` granularity.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1081

def get_observability_errors_usage(opts = {})
  data, _status_code, _headers = get_observability_errors_usage_with_http_info(opts)
  data
end

#get_observability_errors_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get observability errors usage Get time-series arrays of the number of observability errors. Supports `daily` and `monthly` granularity.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1095

def get_observability_errors_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_observability_errors_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/observability/errors'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_observability_errors_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_observability_errors_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_observability_logs_usage(opts = {}) ⇒ `SeriesListRep`

Get observability logs usage Get time-series arrays of the number of observability logs. Supports ‘daily` and `monthly` granularity.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1153

def get_observability_logs_usage(opts = {})
  data, _status_code, _headers = get_observability_logs_usage_with_http_info(opts)
  data
end

#get_observability_logs_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get observability logs usage Get time-series arrays of the number of observability logs. Supports `daily` and `monthly` granularity.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1167

def get_observability_logs_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_observability_logs_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/observability/logs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_observability_logs_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_observability_logs_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_observability_sessions_usage(opts = {}) ⇒ `SeriesListRep`

Get observability sessions usage Get time-series arrays of the number of observability sessions. Supports ‘daily` and `monthly` granularity.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1225

def get_observability_sessions_usage(opts = {})
  data, _status_code, _headers = get_observability_sessions_usage_with_http_info(opts)
  data
end

#get_observability_sessions_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get observability sessions usage Get time-series arrays of the number of observability sessions. Supports `daily` and `monthly` granularity.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1239

def get_observability_sessions_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_observability_sessions_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/observability/sessions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_observability_sessions_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_observability_sessions_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_observability_traces_usage(opts = {}) ⇒ `SeriesListRep`

Get observability traces usage Get time-series arrays of the number of observability traces. Supports ‘daily` and `monthly` granularity.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1297

def get_observability_traces_usage(opts = {})
  data, _status_code, _headers = get_observability_traces_usage_with_http_info(opts)
  data
end

#get_observability_traces_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get observability traces usage Get time-series arrays of the number of observability traces. Supports `daily` and `monthly` granularity.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: month_to_date supports `daily` and `monthly`; incremental and rolling_30d support `daily` only.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`, `rolling_30d`.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1311

def get_observability_traces_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_observability_traces_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/observability/traces'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_observability_traces_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_observability_traces_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_service_connections_usage(opts = {}) ⇒ `SeriesListRepFloat`

Get service connections usage Get a time series array showing the number of service connection minutes from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:connection_type (String) —

A connection type to filter results by. Can be specified multiple times, one query parameter per connection type.
:relay_version (String) —

A relay version to filter results by. Can be specified multiple times, one query parameter per relay version.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:sdk_version (String) —

An SDK version to filter results by. Can be specified multiple times, one query parameter per SDK version.
:sdk_type (String) —

An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `connectionType`, `relayVersion`, `sdkName`, `sdkVersion`, `sdkType`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. `monthly` granularity is only supported with the month_to_date aggregation type. Valid values: `daily`, `hourly`, `monthly`.

Returns:

(SeriesListRepFloat)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1376

def get_service_connections_usage(opts = {})
  data, _status_code, _headers = get_service_connections_usage_with_http_info(opts)
  data
end

#get_service_connections_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRepFloat, Integer, Hash)>`

Get service connections usage Get a time series array showing the number of service connection minutes from your account. The supported granularity varies by aggregation type. The maximum time range is 365 days.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
:to (String) —

The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
:project_key (String) —

A project key to filter results by. Can be specified multiple times, one query parameter per project key.
:environment_key (String) —

An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
:connection_type (String) —

A connection type to filter results by. Can be specified multiple times, one query parameter per connection type.
:relay_version (String) —

A relay version to filter results by. Can be specified multiple times, one query parameter per relay version.
:sdk_name (String) —

An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
:sdk_version (String) —

An SDK version to filter results by. Can be specified multiple times, one query parameter per SDK version.
:sdk_type (String) —

An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
:group_by (String) —

If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension. Valid values: `projectId`, `environmentId`, `connectionType`, `relayVersion`, `sdkName`, `sdkVersion`, `sdkType`.
:aggregation_type (String) —

Specifies the aggregation method. Defaults to `month_to_date`. Valid values: `month_to_date`, `incremental`.
:granularity (String) —

Specifies the data granularity. Defaults to `daily`. `monthly` granularity is only supported with the month_to_date aggregation type. Valid values: `daily`, `hourly`, `monthly`.

Returns:

(Array<(SeriesListRepFloat, Integer, Hash)>) —

SeriesListRepFloat data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1397

def get_service_connections_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_service_connections_usage ...'
  end
  # resource path
  local_var_path = '/api/v2/usage/service-connections'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'connectionType'] = opts[:'connection_type'] if !opts[:'connection_type'].nil?
  query_params[:'relayVersion'] = opts[:'relay_version'] if !opts[:'relay_version'].nil?
  query_params[:'sdkName'] = opts[:'sdk_name'] if !opts[:'sdk_name'].nil?
  query_params[:'sdkVersion'] = opts[:'sdk_version'] if !opts[:'sdk_version'].nil?
  query_params[:'sdkType'] = opts[:'sdk_type'] if !opts[:'sdk_type'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'aggregationType'] = opts[:'aggregation_type'] if !opts[:'aggregation_type'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRepFloat'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_service_connections_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_service_connections_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stream_usage(source, opts = {}) ⇒ `SeriesListRep`

Get stream usage Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.

Parameters:

source (String) —

The source of streaming connections to describe. Must be either `client` or `server`.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 30 days ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.
:tz (String) —

The timezone to use for breaks between days when returning daily data.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1461

def get_stream_usage(source, opts = {})
  data, _status_code, _headers = get_stream_usage_with_http_info(source, opts)
  data
end

#get_stream_usage_by_sdk_version(source, opts = {}) ⇒ `SeriesListRep`

Get stream usage by SDK version Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested. If the requested range is within the past 2 hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.

Parameters:

source (String) —

The source of streaming connections to describe. Must be either `client` or `server`.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 24 hours ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.
:tz (String) —

The timezone to use for breaks between days when returning daily data.
:sdk (String) —

If included, this filters the returned series to only those that match this SDK name.
:version (String) —

If included, this filters the returned series to only those that match this SDK version.

Returns:

(SeriesListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1535

def get_stream_usage_by_sdk_version(source, opts = {})
  data, _status_code, _headers = get_stream_usage_by_sdk_version_with_http_info(source, opts)
  data
end

#get_stream_usage_by_sdk_version_with_http_info(source, opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get stream usage by SDK version Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested. If the requested range is within the past 2 hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.

Parameters:

source (String) —

The source of streaming connections to describe. Must be either `client` or `server`.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 24 hours ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.
:tz (String) —

The timezone to use for breaks between days when returning daily data.
:sdk (String) —

If included, this filters the returned series to only those that match this SDK name.
:version (String) —

If included, this filters the returned series to only those that match this SDK version.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1550

def get_stream_usage_by_sdk_version_with_http_info(source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_stream_usage_by_sdk_version ...'
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling AccountUsageBetaApi.get_stream_usage_by_sdk_version"
  end
  # resource path
  local_var_path = '/api/v2/usage/streams/{source}/bysdkversion'.sub('{' + 'source' + '}', CGI.escape(source.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'tz'] = opts[:'tz'] if !opts[:'tz'].nil?
  query_params[:'sdk'] = opts[:'sdk'] if !opts[:'sdk'].nil?
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_stream_usage_by_sdk_version",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_stream_usage_by_sdk_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stream_usage_sdkversion(source, opts = {}) ⇒ `SdkVersionListRep`

Get stream usage SDK versions Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days.

Parameters:

source (String) —

The source of streaming connections to describe. Must be either `client` or `server`.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(SdkVersionListRep)

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1608

def get_stream_usage_sdkversion(source, opts = {})
  data, _status_code, _headers = get_stream_usage_sdkversion_with_http_info(source, opts)
  data
end

#get_stream_usage_sdkversion_with_http_info(source, opts = {}) ⇒ `Array<(SdkVersionListRep, Integer, Hash)>`

Get stream usage SDK versions Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days.

Parameters:

source (String) —

The source of streaming connections to describe. Must be either `client` or `server`.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(SdkVersionListRep, Integer, Hash)>) —

SdkVersionListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1618

def get_stream_usage_sdkversion_with_http_info(source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_stream_usage_sdkversion ...'
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling AccountUsageBetaApi.get_stream_usage_sdkversion"
  end
  # resource path
  local_var_path = '/api/v2/usage/streams/{source}/sdkversions'.sub('{' + 'source' + '}', CGI.escape(source.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SdkVersionListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_stream_usage_sdkversion",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_stream_usage_sdkversion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stream_usage_with_http_info(source, opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

Get stream usage Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.

Parameters:

source (String) —

The source of streaming connections to describe. Must be either `client` or `server`.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:from (String) —

The series of data returned starts from this timestamp. Defaults to 30 days ago.
:to (String) —

The series of data returned ends at this timestamp. Defaults to the current time.
:tz (String) —

The timezone to use for breaks between days when returning daily data.

Returns:

(Array<(SeriesListRep, Integer, Hash)>) —

SeriesListRep data, response status code and response headers

# File 'lib/launchdarkly_api/api/account_usage_beta_api.rb', line 1474

def get_stream_usage_with_http_info(source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountUsageBetaApi.get_stream_usage ...'
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling AccountUsageBetaApi.get_stream_usage"
  end
  # resource path
  local_var_path = '/api/v2/usage/streams/{source}'.sub('{' + 'source' + '}', CGI.escape(source.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'tz'] = opts[:'tz'] if !opts[:'tz'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SeriesListRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AccountUsageBetaApi.get_stream_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountUsageBetaApi#get_stream_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountUsageBetaApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#get_contexts_clientside_usage(opts = {}) ⇒ SeriesListRep

#get_contexts_clientside_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_contexts_serverside_usage(opts = {}) ⇒ SeriesListRep

#get_contexts_serverside_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_contexts_total_usage(opts = {}) ⇒ SeriesListRep

#get_contexts_total_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_data_export_events_usage(opts = {}) ⇒ SeriesListRep

#get_data_export_events_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_evaluations_usage(project_key, environment_key, feature_flag_key, opts = {}) ⇒ SeriesListRep

#get_evaluations_usage_with_http_info(project_key, environment_key, feature_flag_key, opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_events_usage(type, opts = {}) ⇒ SeriesListRep

#get_events_usage_with_http_info(type, opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_experimentation_events_usage(opts = {}) ⇒ SeriesListRep

#get_experimentation_events_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_experimentation_keys_usage(opts = {}) ⇒ SeriesListRep

#get_experimentation_keys_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_mau_clientside_usage(opts = {}) ⇒ SeriesListRep

#get_mau_clientside_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_mau_sdks_by_type(opts = {}) ⇒ SdkListRep

#get_mau_sdks_by_type_with_http_info(opts = {}) ⇒ Array<(SdkListRep, Integer, Hash)>

#get_mau_total_usage(opts = {}) ⇒ SeriesListRep

#get_mau_total_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_mau_usage(opts = {}) ⇒ SeriesListRep

#get_mau_usage_by_category(opts = {}) ⇒ SeriesListRep

#get_mau_usage_by_category_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_mau_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_observability_errors_usage(opts = {}) ⇒ SeriesListRep

#get_observability_errors_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_observability_logs_usage(opts = {}) ⇒ SeriesListRep

#get_observability_logs_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_observability_sessions_usage(opts = {}) ⇒ SeriesListRep

#get_observability_sessions_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_observability_traces_usage(opts = {}) ⇒ SeriesListRep

#get_observability_traces_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_service_connections_usage(opts = {}) ⇒ SeriesListRepFloat

#get_service_connections_usage_with_http_info(opts = {}) ⇒ Array<(SeriesListRepFloat, Integer, Hash)>

#get_stream_usage(source, opts = {}) ⇒ SeriesListRep

#get_stream_usage_by_sdk_version(source, opts = {}) ⇒ SeriesListRep

#get_stream_usage_by_sdk_version_with_http_info(source, opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#get_stream_usage_sdkversion(source, opts = {}) ⇒ SdkVersionListRep

#get_stream_usage_sdkversion_with_http_info(source, opts = {}) ⇒ Array<(SdkVersionListRep, Integer, Hash)>

#get_stream_usage_with_http_info(source, opts = {}) ⇒ Array<(SeriesListRep, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `AccountUsageBetaApi`

#api_client ⇒ `Object`

#get_contexts_clientside_usage(opts = {}) ⇒ `SeriesListRep`

#get_contexts_clientside_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_contexts_serverside_usage(opts = {}) ⇒ `SeriesListRep`

#get_contexts_serverside_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_contexts_total_usage(opts = {}) ⇒ `SeriesListRep`

#get_contexts_total_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_data_export_events_usage(opts = {}) ⇒ `SeriesListRep`

#get_data_export_events_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_evaluations_usage(project_key, environment_key, feature_flag_key, opts = {}) ⇒ `SeriesListRep`

#get_evaluations_usage_with_http_info(project_key, environment_key, feature_flag_key, opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_events_usage(type, opts = {}) ⇒ `SeriesListRep`

#get_events_usage_with_http_info(type, opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_experimentation_events_usage(opts = {}) ⇒ `SeriesListRep`

#get_experimentation_events_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_experimentation_keys_usage(opts = {}) ⇒ `SeriesListRep`

#get_experimentation_keys_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_mau_clientside_usage(opts = {}) ⇒ `SeriesListRep`

#get_mau_clientside_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_mau_sdks_by_type(opts = {}) ⇒ `SdkListRep`

#get_mau_sdks_by_type_with_http_info(opts = {}) ⇒ `Array<(SdkListRep, Integer, Hash)>`

#get_mau_total_usage(opts = {}) ⇒ `SeriesListRep`

#get_mau_total_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_mau_usage(opts = {}) ⇒ `SeriesListRep`

#get_mau_usage_by_category(opts = {}) ⇒ `SeriesListRep`

#get_mau_usage_by_category_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_mau_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_observability_errors_usage(opts = {}) ⇒ `SeriesListRep`

#get_observability_errors_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_observability_logs_usage(opts = {}) ⇒ `SeriesListRep`

#get_observability_logs_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_observability_sessions_usage(opts = {}) ⇒ `SeriesListRep`

#get_observability_sessions_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_observability_traces_usage(opts = {}) ⇒ `SeriesListRep`

#get_observability_traces_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_service_connections_usage(opts = {}) ⇒ `SeriesListRepFloat`

#get_service_connections_usage_with_http_info(opts = {}) ⇒ `Array<(SeriesListRepFloat, Integer, Hash)>`

#get_stream_usage(source, opts = {}) ⇒ `SeriesListRep`

#get_stream_usage_by_sdk_version(source, opts = {}) ⇒ `SeriesListRep`

#get_stream_usage_by_sdk_version_with_http_info(source, opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`

#get_stream_usage_sdkversion(source, opts = {}) ⇒ `SdkVersionListRep`

#get_stream_usage_sdkversion_with_http_info(source, opts = {}) ⇒ `Array<(SdkVersionListRep, Integer, Hash)>`

#get_stream_usage_with_http_info(source, opts = {}) ⇒ `Array<(SeriesListRep, Integer, Hash)>`