Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

ListDeliverabilityTestReports

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.

Request Syntax

GET /v1/email/deliverability-dashboard/test-reports?NextToken=NextToken&PageSize=PageSize HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

NextToken

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

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.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DeliverabilityTestReports": [ { "CreateDate": number, "DeliverabilityTestStatus": "string", "FromEmailAddress": "string", "ReportId": "string", "ReportName": "string", "Subject": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DeliverabilityTestReports

An object that contains a lists of predictive inbox placement tests that you've performed.

Type: Array of DeliverabilityTestReport objects

NextToken

A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: