Skip to main content
POST
Search traffic logs

Authorizations

X-API-KEY
string
header
required

Query Parameters

start_at
integer

The offset from the first result. Defaults to 0. To fetch the next page, increase start_at by count. For example, with count set to 20, use offsets of 0, 20, and 40 for the first three pages. Requests return 400 Bad Request if start_at + count exceeds 9,999.

count
integer

The number of results to return per page. Defaults to 20. The maximum is 100.

Required range: x <= 100

Body

application/json

Filters for the search query. If omitted, returns logs for the authenticated account without additional filters. Use count to control the number of results per page.

delivered
enum<string>

Y means the email is delivered while N means not delivered.

Available options:
Y,
N
end_date
string

Must be in the form yyyy-mm-dd and be after start_date. If end_date is present, start_date must be present too.

lastcmd
string

Last SMTP command.

message_id
string

ID of the message.

rcpt
string

The recipient email addresses. This should correspond to the addresses in the SMTP RCPT TO: commands.

rspcode
integer

SMTP response code.

rspmsg
string

SMTP response message.

sender
string

The sender email address. This should correspond to the address in the SMTP MAIL FROM: command.

sender_id
string

The identity of the sender, if different from the envelope sender. This should correspond to a single customer.

spam_disposition
enum<string>

Disposition of spam.

Available options:
CONFIRMED,
SUSPECT,
BULK,
UNKNOWN
start_date
string

Must be in the form yyyy-mm-dd and be before end_date. If start_date is present, end_date must be present too.

subject
string

Subject of email.

upstream
string

Upstream IP address.

upstream_hostname
string

Host name of upstream.

virus_disposition
enum<string>

Disposition of virus.

Available options:
CONFIRMED,
HIGH,
MEDIUM,
UNKNOWN

Response

Successful response.

notice
string

An optional notice about the search results, such as a reminder that results are limited to the last 3 days of data.

results
object[]