listDeliverabilityTestReports method

Future<ListDeliverabilityTestReportsResponse> listDeliverabilityTestReports({
  1. String? nextToken,
  2. int? pageSize,
})

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

May throw TooManyRequestsException. May throw NotFoundException. May throw BadRequestException.

Parameter nextToken : A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

Parameter pageSize : The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 0, and can be no more than 1000.

Implementation

Future<ListDeliverabilityTestReportsResponse> listDeliverabilityTestReports({
  String? nextToken,
  int? pageSize,
}) async {
  final $query = <String, List<String>>{
    if (nextToken != null) 'NextToken': [nextToken],
    if (pageSize != null) 'PageSize': [pageSize.toString()],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/v1/email/deliverability-dashboard/test-reports',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListDeliverabilityTestReportsResponse.fromJson(response);
}