Skip to main content
GET
Get logs for all account domains

Authorizations

Authorization
string
header
required

API key for account management endpoints. Use your api_ prefixed token.

Query Parameters

domains
string

Comma-separated list of domain names to filter to (e.g. "example.com,mail.example.com"). May also be supplied as a repeated "domains[]" parameter. If omitted, queries all domains in the account (up to 20).

logtype
enum<string>

Filter to messages that reached this stage. The full timeline of a matched message is still returned.

Available options:
spam,
delivery,
inbound,
outbound,
blocked,
rejected
to
string<email>

Filter by recipient email

from
string<email>

Filter by sender email

from_domain
string

Filter by the sender's domain. Matches the domain itself and any subdomain of it. Distinct from the recipient domain the message arrived on, which is filtered with the domains parameter.

Maximum string length: 253
Example:

"example.com"

subject
string

Filter by subject

Maximum string length: 500
ip
string

Filter by IP address

date_from
integer

Start of date range (Unix timestamp in milliseconds; values that look like seconds are scaled up)

date_to
integer

End of date range (Unix timestamp in milliseconds; values that look like seconds are scaled up)

spamscore_min
number

Minimum spam score filter

spamscore_max
number

Maximum spam score filter

host
string

Filter by the delivery host a message was forwarded to. Only delivery events carry a host; use from_domain to filter by the sending domain.

port
integer

Filter by port number

Required range: 1 <= x <= 65535
mode
enum<string>

Filter by connection mode

Available options:
smtp,
http,
https
limit
integer
default:100

Number of entries to return (applied after merging all domains)

Required range: 1 <= x <= 1000
offset
integer

Number of entries to skip

Required range: x >= 0
page
integer

Page number (alternative to offset, takes precedence)

Required range: x >= 1
sort_by
string
default:date

Field to sort by

sort_order
enum<string>
default:DESC

Sort direction

Available options:
ASC,
DESC

Response

Successfully retrieved account-wide logs

success
boolean
Example:

true

data
object[]

Merged and sorted consolidated log entries from all queried domains. Each entry represents a single inbound email (keyed by uid) with aggregated delivery/rejection counts and an actions array of underlying log rows. Entries are tagged with _domain, _domain_uuid, and _domain_type identifying the source domain.

pagination
object
domains_queried
object[]

Status of each domain query

total_domains
integer

Total number of domains in the account

Example:

5

domains_included
integer

Number of domains actually queried (may be capped at 20)

Example:

5