Download logs
Download logs
Description: Our API programmatically allows you to download logs for your account. Submitting a request to this endpoint will process all logs for your account and email them to you as an attachment (Gzip compressed CSV spreadsheet file) once complete.
This allows you to create background jobs with a Cron job or using Node.js job scheduling software Bree to receive logs whenever you desire. Note that this endpoint is limited to 10 requests per day.
The attachment is the lowercase form of email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz and the email itself contains a brief summary of the logs retrieved.
The CSV spreadsheet includes the following columns: Log ID, Session ID, Date, Level, Bounce Category, Bounce Action, Truth Source, SMTP Response, SMTP Code, From, From Allowlisted, To, Subject, Message-ID, MAIL FROM, RCPT TO, Client IP, Client Hostname, Client Allowlisted, Target Host, Target MX Hostname, Target MX IP, Target Type, Opportunistic TLS, Require TLS, MX Hostname, MX IP, SPF, DKIM, Delivered To, Delivery Time (ms), and Message Size (bytes).
Request
- Base URL: https://api.forwardemail.net
- URL: https://api.forwardemail.net/v1/logs/download
- Auth: HTTP basic
Query parameters
Filter logs by fully qualified domain ("FQDN"). If not provided, all logs across all domains will be retrieved.
Search for logs by email, domain, alias name, IP address, or date (M/Y, M/D/YY, M-D, M-D-YY, or M.D.YY format).
Search for logs by a specific bounce category (e.g. "blocklist").
Search for logs by a specific error response code (e.g. 421 or 550).
If set to true or 1, an email will always be sent even if no logs are found. The email will indicate that no logs were available and will not contain an attachment.
Response
Logs will be emailed as an attachment
Example response
{
"message": "Logs will be emailed to you shortly"
}Changes
No recorded changes to this operation across all 1 revision of this API.