getIndex method

Future<GetCustomerIndexStatsResponse> getIndex({
  1. int? fromDate_day,
  2. int? fromDate_month,
  3. int? fromDate_year,
  4. int? toDate_day,
  5. int? toDate_month,
  6. int? toDate_year,
  7. String? $fields,
})

Gets indexed item statistics aggreggated across all data sources.

This API only returns statistics for previous dates; it doesn't return statistics for the current day. Note: This API requires a standard end user account to execute.

Request parameters:

fromDate_day - Day of month. Must be from 1 to 31 and valid for the year and month.

fromDate_month - Month of date. Must be from 1 to 12.

fromDate_year - Year of date. Must be from 1 to 9999.

toDate_day - Day of month. Must be from 1 to 31 and valid for the year and month.

toDate_month - Month of date. Must be from 1 to 12.

toDate_year - Year of date. Must be from 1 to 9999.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GetCustomerIndexStatsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GetCustomerIndexStatsResponse> getIndex({
  core.int? fromDate_day,
  core.int? fromDate_month,
  core.int? fromDate_year,
  core.int? toDate_day,
  core.int? toDate_month,
  core.int? toDate_year,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (fromDate_day != null) 'fromDate.day': ['${fromDate_day}'],
    if (fromDate_month != null) 'fromDate.month': ['${fromDate_month}'],
    if (fromDate_year != null) 'fromDate.year': ['${fromDate_year}'],
    if (toDate_day != null) 'toDate.day': ['${toDate_day}'],
    if (toDate_month != null) 'toDate.month': ['${toDate_month}'],
    if (toDate_year != null) 'toDate.year': ['${toDate_year}'],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'v1/stats/index';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GetCustomerIndexStatsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}