GetDeliverabilityTestReport
Retrieve the results of a predictive inbox placement test.
Request Syntax
GET /v2/email/deliverability-dashboard/test-reports/ReportId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ReportId
-
A unique string that identifies the predictive inbox placement test.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DeliverabilityTestReport": {
"CreateDate": number,
"DeliverabilityTestStatus": "string",
"FromEmailAddress": "string",
"ReportId": "string",
"ReportName": "string",
"Subject": "string"
},
"IspPlacements": [
{
"IspName": "string",
"PlacementStatistics": {
"DkimPercentage": number,
"InboxPercentage": number,
"MissingPercentage": number,
"SpamPercentage": number,
"SpfPercentage": number
}
}
],
"Message": "string",
"OverallPlacement": {
"DkimPercentage": number,
"InboxPercentage": number,
"MissingPercentage": number,
"SpamPercentage": number,
"SpfPercentage": number
},
"Tags": [
{
"Key": "string",
"Value": "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.
- DeliverabilityTestReport
-
An object that contains the results of the predictive inbox placement test.
Type: DeliverabilityTestReport object
- IspPlacements
-
An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
Type: Array of IspPlacement objects
- Message
-
An object that contains the message that you sent when you performed this predictive inbox placement test.
Type: String
- OverallPlacement
-
An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
Type: PlacementStatistics object
- Tags
-
An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
Type: Array of Tag objects
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:
