Email Logs

View SES API request and response logs to track email delivery status and debug issues.

GET/api/v1/email-logs

Get a cursor-paginated list of email logs for the authenticated account. Supports optional query parameters: status (sent, failed, delivered, bounced, complained, opened), operation (e.g., SendBulkEmail), recipient (partial match), per_page (default 25, max 100), and cursor (next/previous page token).

Response Fields

idinteger

The email log ID.

providerstring

The email provider (e.g., ses).

operationstring

The SES API operation name.

recipientstring

The recipient email address (null for non-send operations).

message_idstring

The SES message ID (null for non-send operations).

statusstring

The log status: sent, failed, delivered, bounced, complained, or opened.

errorstring

Error message if the operation failed.

request_payloadobject

The full SES API request payload (null for bulk per-recipient rows).

response_payloadobject

The SES API response payload.

sns_payloadobject

The SNS event payload from delivery notifications.

logged_atstring

ISO 8601 timestamp when the log was recorded.

created_atstring

ISO 8601 creation timestamp.

Request

curl -X GET \
  "https://byomailer.com/api/v1/email-logs" \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Response

200

{
  "data": [
    {
      "id": 1,
      "provider": "ses",
      "operation": "SendBulkEmail",
      "recipient": "[email protected]",
      "message_id": "0102018e-abcd-1234-5678-abcdef123456",
      "status": "sent",
      "error": null,
      "request_payload": null,
      "response_payload": {
        "Status": "SUCCESS",
        "MessageId": "0102018e-abcd-1234-5678-abcdef123456"
      },
      "sns_payload": null,
      "logged_at": "2024-01-15T10:30:00.000000Z",
      "created_at": "2024-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "path": "https://byomailer.com/api/v1/email-logs",
    "per_page": 25,
    "next_cursor": "eyJpZCI6MTAxLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
    "prev_cursor": null
  }
}

GET/api/v1/email-logs/{emailLogId}

Get a single email log entry by ID.

Path Parameters

emailLogIdinteger

required

The ID of the email log to retrieve.