Retrieve inbox placement and engagement rates for the domains that you use to send email.
Request Syntax
GET /v1/email/deliverability-dashboard/statistics-report/Domain?EndDate=EndDate&StartDate=StartDate HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Domain
-
The domain that you want to obtain deliverability metrics for.
Required: Yes
- EndDate
-
The last day (in Unix time) that you want to obtain domain deliverability metrics for. The
EndDatethat you specify has to be less than or equal to 30 days after theStartDate.Required: Yes
- StartDate
-
The first day (in Unix time) that you want to obtain domain deliverability metrics for.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DailyVolumes": [
{
"DomainIspPlacements": [
{
"InboxPercentage": number,
"InboxRawCount": number,
"IspName": "string",
"SpamPercentage": number,
"SpamRawCount": number
}
],
"StartDate": number,
"VolumeStatistics": {
"InboxRawCount": number,
"ProjectedInbox": number,
"ProjectedSpam": number,
"SpamRawCount": number
}
}
],
"OverallVolume": {
"DomainIspPlacements": [
{
"InboxPercentage": number,
"InboxRawCount": number,
"IspName": "string",
"SpamPercentage": number,
"SpamRawCount": number
}
],
"ReadRatePercent": number,
"VolumeStatistics": {
"InboxRawCount": number,
"ProjectedInbox": number,
"ProjectedSpam": number,
"SpamRawCount": number
}
}
}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.
- DailyVolumes
-
An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the
StartDateand ending on theEndDate.Type: Array of DailyVolume objects
- OverallVolume
-
An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the
StartDateto theEndDate.Type: OverallVolume object
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:
