ListDomainDeliverabilityCampaigns
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.
Request Syntax
GET /v2/email/deliverability-dashboard/domains/SubscribedDomain/campaigns?EndDate=EndDate&NextToken=NextToken&PageSize=PageSize&StartDate=StartDate HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- EndDate
-
The last day that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the
StartDateparameter.Required: Yes
- NextToken
-
A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaignsoperation. This token indicates the position of a campaign in the list of campaigns. - PageSize
-
The maximum number of results to include in response to a single call to the
ListDomainDeliverabilityCampaignsoperation. If the number of results is larger than the number that you specify in this parameter, the response includes aNextTokenelement, which you can use to obtain additional results. - StartDate
-
The first day that you want to obtain deliverability data for.
Required: Yes
- SubscribedDomain
-
The domain to obtain deliverability data for.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DomainDeliverabilityCampaigns": [
{
"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"
}
],
"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.
- DomainDeliverabilityCampaigns
-
An array of responses, one for each campaign that used the domain to send email during the specified time range.
Type: Array of DomainDeliverabilityCampaign objects
- NextToken
-
A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaignsoperation. This token indicates the position of the campaign in the list of campaigns.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:
