Stream logs for authenticated user domain in real-time

GET

/api/domains/{domain}/log/stream

const url = 'https://smtp-app.kirim.email/api/domains/example.com/log/stream?start=2023-01-01T00%3A00%3A00Z&end=2023-12-31T23%3A59%3A59Z&sender=sender%40example.com&recipient=recipient%40example.com&subject=Welcome&event_type=delivered&tags=newsletter&limit=50000';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://smtp-app.kirim.email/api/domains/example.com/log/stream?start=2023-01-01T00%3A00%3A00Z&end=2023-12-31T23%3A59%3A59Z&sender=sender%40example.com&recipient=recipient%40example.com&subject=Welcome&event_type=delivered&tags=newsletter&limit=50000' \
  --header 'Authorization: Basic <credentials>'

Stream email logs in real-time using Server-Sent Events for a domain owned by the authenticated user

Authorizations

basicAuth

Parameters

Path Parameters

domain

required

string

Example

example.com

Domain name that must be owned by the authenticated user. The domain must be verified and properly configured for email sending.

Query Parameters

start

string format: date-time

Example

2023-01-01T00:00:00Z

Filter logs by start date (ISO8601)

end

string format: date-time

Example

2023-12-31T23:59:59Z

Filter logs by end date (ISO8601)

sender

string

Example

[email protected]

Filter logs by sender email

recipient

string

Example

[email protected]

Filter logs by recipient email

subject

string

Example

Welcome

Filter logs by subject (partial match)

event_type

string

Example

delivered

Filter logs by event type (queued, delivered, bounced, failed, opened, clicked, unsubscribed, temporary_fail, permanent_fail, deferred)

tags

string

Example

newsletter

Filter logs by tags (partial match)

limit

integer

default: 50000 >= 1 <= 500000

Maximum number of logs to stream

Responses

200

Server-Sent Events stream

text/event-stream

SSE stream with log data batches and completion events

string

Headers

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Remaining requests in current window

400

Bad Request - User authentication missing

application/json

object

error

string

Example

{
  "error": "User authentication missing"
}

401

Unauthorized - Invalid or missing authentication

application/json

object

error

string

Example

{
  "error": "Unauthorized"
}

404

Not Found - Domain or log not found

application/json

object

error

string

Example

{
  "error": "Domain not found or you do not own this domain"
}

429

Too Many Requests - Rate limit exceeded. Retry after the specified time.

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Too many attempts. Please try again later."
}

Headers

Retry-After

integer

Seconds until rate limit resets

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Remaining requests in current window

500

Server Error - Unexpected error occurred

application/json

object

error

string

Example

{
  "error": "Unknown error"
}