SES Monitor Domains API

The SES Monitor API's Domains Endpoint allows you to retrieve information about the verified identities within your SES Monitor account. This guide will explain how to use the "domain" query parameter to search for specific domains and how to navigate through results using pagination.

See also: Authenticating with the SES Monitor API

Query Parameters

domain

• Description: Filters the results to return information about a specific domain.
• Format: A string representing the domain name (e.g., "example.com").
• Usage: To retrieve data for a domain that matches the provided domain name.
• Using the Domain Query Parameter with curl

Here's an example of how to use the "domain" query parameter in a CURL command:

curl -X POST 'https://api.sesmonitor.com/api/v1/domains/list' \
-H 'Authorization: Bearer YOUR_API_ACCESS_KEY' \
-H 'Content-Type: application/json' \
-d '{"query": {"domain": "example.com"}}'

Replace YOUR_API_ACCESS_KEY with your actual API access key and "example.com" with the domain you wish to query.

Domain Pagination

The domains endpoint supports pagination which enables you to retrieve a list of domain and have it chuned into pages.

page

• Description: Specifies the page number of the results.
• Format: An integer.
• Usage: To navigate through multiple pages of results.

per_page

• Description: Determines the number of results per page.
• Default: 25 results per page.
• Maximum: Can be set up to 100 results per page.
• Format: An integer.
• Usage: To adjust the number of results returned in a single request.

To implement pagination in your request, you'll need to include the page and per_page fields in your POST data. Here's an example using CURL:

curl -X POST 'https://api.sesmonitor.com/api/v1/domains/list' \
-H 'Authorization: Bearer YOUR_API_ACCESS_KEY' \
-H 'Content-Type: application/json' \
-d '{
      "query": {"domain": "example.com"},
      "page": 1,
      "per_page": 30
    }'