GetDomainDeliverabilityCampaign
Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.
Request Syntax
GET /v2/email/deliverability-dashboard/campaigns/CampaignId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- CampaignId
-
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DomainDeliverabilityCampaign": {
"CampaignId": "string",
"DeleteRate": number,
"Esps": [ "string" ],
"FirstSeenDateTime": number,
"FromAddress": "string",
"ImageUrl": "string",
"InboxCount": number,
"LastSeenDateTime": number,
"ProjectedVolume": number,
"ReadDeleteRate": number,
"ReadRate": number,
"SendingIps": [ "string" ],
"SpamCount": number,
"Subject": "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.
- DomainDeliverabilityCampaign
-
An object that contains the deliverability data for the campaign.
Type: DomainDeliverabilityCampaign 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: