Stream logs for authenticated user domain in real-time
GET /api/domains/{domain}/log/stream
Stream email logs in real-time using Server-Sent Events for a domain owned by the authenticated user
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Example
example.comDomain name that must be owned by the authenticated user. The domain must be verified and properly configured for email sending.
Query Parameters
Section titled “Query Parameters ”Example
2023-01-01T00:00:00ZFilter logs by start date (ISO8601)
Example
2023-12-31T23:59:59ZFilter logs by end date (ISO8601)
Example
WelcomeFilter logs by subject (partial match)
Example
deliveredFilter logs by event type (queued, delivered, bounced, failed, opened, clicked, unsubscribed, temporary_fail, permanent_fail, deferred)
Example
newsletterFilter logs by tags (partial match)
Maximum number of logs to stream
Responses
Section titled “ Responses ”Server-Sent Events stream
SSE stream with log data batches and completion events
Headers
Section titled “Headers ”Maximum requests per minute
Remaining requests in current window
Bad Request - User authentication missing
object
Example
User authentication missingUnauthorized - Invalid or missing authentication
object
Example
UnauthorizedNot Found - Domain or log not found
object
Example
Domain not found or you do not own this domainToo Many Requests - Rate limit exceeded. Retry after the specified time.
object
Example
Too many attempts. Please try again later.Headers
Section titled “Headers ”Seconds until rate limit resets
Maximum requests per minute
Remaining requests in current window
Server Error - Unexpected error occurred
object
Example
Unknown error