GET

/v2/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns#StartDate&EndDate

http://email.{region}.amazonaws.com/v2/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns#StartDate&EndDate

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.

Access Token Required: API Key

Path Parameters

SubscribedDomainstringrequired

The domain to obtain deliverability data for.

Query Params

StartDatestringrequired

The first day that you want to obtain deliverability data for.

EndDatestringrequired

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 <code>StartDate</code> parameter.

NextTokenstring

A token that’s returned from a previous call to the <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the position of a campaign in the list of campaigns.

PageSizeinteger

The maximum number of results to include in response to a single call to the <code>ListDomainDeliverabilityCampaigns</code> operation. If the number of results is larger than the number that you specify in this parameter, the response includes a <code>NextToken</code> element, which you can use to obtain additional results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://email.{region}.amazonaws.com/v2/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns#StartDate&EndDate' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}