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

GetDeliverabilityDashboardOptions

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Request Syntax

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

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AccountStatus": "string", "ActiveSubscribedDomains": [ { "Domain": "string", "InboxPlacementTrackingOption": { "Global": boolean, "TrackedIsps": [ "string" ] }, "SubscriptionStartDate": number } ], "DashboardEnabled": boolean, "PendingExpirationSubscribedDomains": [ { "Domain": "string", "InboxPlacementTrackingOption": { "Global": boolean, "TrackedIsps": [ "string" ] }, "SubscriptionStartDate": number } ], "SubscriptionExpiryDate": 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.

AccountStatus

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

Type: String

Valid Values: ACTIVE | PENDING_EXPIRATION | DISABLED

ActiveSubscribedDomains

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

Type: Array of DomainDeliverabilityTrackingOption objects

DashboardEnabled

Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

Type: Boolean

PendingExpirationSubscribedDomains

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.

Type: Array of DomainDeliverabilityTrackingOption objects

SubscriptionExpiryDate

The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

Type: Timestamp

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

LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400

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: