search method

Future<SearchResponse> search(
  1. SearchRequest request,
  2. String merchantId, {
  3. String? $fields,
})

Retrieves merchant performance metrics matching the search query and optionally segmented by selected dimensions.

request - The metadata request object.

Request parameters:

merchantId - Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.

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

Completes with a SearchResponse.

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<SearchResponse> search(
  SearchRequest request,
  core.String merchantId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = commons.escapeVariable('$merchantId') + '/reports/search';

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