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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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 (PutDeliverabilityDashboardOption operation).

Request Syntax

GET /v1/email/deliverability-dashboard/campaigns/CampaignId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

CampaignId

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

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: