VOOZH about

URL: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs

⇱ Logs

Skip to content

Mailgun API (3.0.0)

Mailgun API defined by OpenAPI Specification (OAS) 3.1.0

Download OpenAPI description
Languages
Servers
US Mailgun
https://api.mailgun.net
EU Mailgun
https://api.eu.mailgun.net

Messages

Send email two ways via our REST API:

  1. Send emails using MIME format using a MIME building library
  2. Submit the individual parts (Text, html, attachments, etc.)

Reminder: You can also send email via SMTP with Mailgun. Please reference the user manual.

Operations

Domains

Domains API manages domains, domain keys and DNS verification.

Operations

Domain Keys

An authentication standard used to prevent email spoofing.

Operations

Domain Tracking

Mailgun offers tracking for clicks, unsubscribes, and opens, with optional HTTPS protocol support on tracking URLs. To enable HTTPS, Mailgun uses Let’s Encrypt with HTTP-01 challenges through your existing tracking CNAME record to issue a TLS certificate. This setup also includes support for HTTP Strict Transport Security (HSTS) for enhanced security.

Operations

DKIM Security

Automatic Sender Security DKIM Key APIs. To enable this feature please see 'Update a domain' API docs.

Operations

Account Webhooks

Webhooks API to manage account-specific webhooks. You can create, retrieve, update, and delete webhooks programmatically. Account-level webhooks are configured independently for US and EU regions. When triggered, webhook URLs are deduplicated by event type, across account and domain levels to prevent redundant webhook sends.

Operations

Domain Webhooks

Webhooks API to manage domain-specific webhooks. You can create, retrieve, update, and delete webhooks programmatically. When triggered, webhook URLs are deduplicated by event type, across account and domain levels to prevent redundant webhook sends.

Operations

Metrics

The Mailgun Metrics API provides programmatic access to detailed analytics data about your email sending activity. This API allows you to query, filter, and analyze email performance metrics to gain insights into deliverability, engagement, and overall sending health.

Operations

Logs

Mailgun keeps track of every inbound and outbound message event and stores this log data. Using this logs API, this data can be queried and filtered to provide insights into the health of your email infrastructure.

Operations

List logs

Request

Gets customer event logs for an account

Security
basicAuth or basicAuth
Bodyapplication/jsonrequired
startstring

The start date (default: 1 day before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14

endstring

The end date (default: current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14

durationstringrequired

A duration in the format of '1d' '2h'. If duration is provided then it is calculated from the end date and overwrites the start date.

eventsArray of strings(github.com-mailgun-logs-api-pkg-api-model-Event)

The set of events to include.

Items Enum ValueDescription
accepted

logs with event=accepted

delivered

logs with event=delivered

failed

logs with event=failed

opened

logs with event=opened

unique_opened

logs with event=opened unique per message-id, recipient combination

clicked

logs with event=clicked

unique_clicked

logs with event=clicked unique per message-id, recipient combination

unsubscribed

logs with event=unsubscribed

complained

logs with event=complained

rejected

logs with event=rejected

metric_eventsArray of strings(github.com-mailgun-logs-api-pkg-api-model-MetricEvent)

Optional set of analytics metric events. Will be converted into corresponding events.

Items Enum ValueDescription
accepted_incoming

accepted events where flags.is_authenticated is false

accepted_outgoing

accepted events where flags.is_authenticated is true

accepted

all accepted events

delivered_smtp

delivered events where envelope.transport is smtp

delivered_http

delivered events where envelope.transport is http

delivered_optimized

delivered events where i-delivery-optimizer is set

delivered

all delivered events

stored

all stored events

opened

all opened events

clicked

all clicked events

filterobject

Filters to apply to the query.

include_subaccountsboolean

Include logs from all subaccounts.

include_totalsboolean

Include total number of log entries.

paginationobject(github.com-mailgun-logs-api-pkg-api-model-Pagination)
  • US Mailgun
    https://api.mailgun.net/v1/analytics/logs
  • EU Mailgun
    https://api.eu.mailgun.net/v1/analytics/logs
  • curl
  • JavaScript
  • Node.js
  • Python
  • Java
  • C#
  • PHP
  • Go
  • Ruby
  • R
  • Payload
curl -i -X POST \
 -u <username>:<password> \
 https://api.mailgun.net/v1/analytics/logs \
 -H 'Content-Type: application/json' \
 -d '{
 "start": "Mon, 08 Jul 2024 00:00:00 -0000",
 "end": "Fri, 12 Jul 2024 00:00:00 -0000",
 "filter": {
 "AND": [
 {
 "attribute": "domain",
 "comparator": "=",
 "values": [
 {
 "label": "example.com",
 "value": "example.com"
 }
 ]
 }
 ]
 },
 "include_subaccounts": true,
 "pagination": {
 "sort": "timestamp:asc",
 "token": "cjsijbijewbu78t678tVTYUYU76754fyuiksin865g",
 "limit": 50
 }
 }'

Responses

A 200 response

Bodyapplication/json
startstringrequired
endstringrequired
itemsArray of objects(github.com-mailgun-logs-api-pkg-api-model-LogEvent)required
items[].​idstringrequired
items[].​eventstringrequired
items[].​@timestampstringrequired
items[].​accountgithub.com-mailgun-logs-api-pkg-api-model-Account (object) or null
Any of:
items[].​campaignsArray of objects(github.com-mailgun-logs-api-pkg-api-model-Campaign)
items[].​tagsArray of strings
items[].​methodstring
items[].​originating-ipstring
items[].​api-key-idstring
items[].​delivered-atstring
items[].​delivery-statusgithub.com-mailgun-logs-api-pkg-api-model-DeliveryStatus (object) or null
Any of:
items[].​i-delivery-optimizerstring
items[].​domaingithub.com-mailgun-logs-api-pkg-api-model-Domain (object) or nullrequired
Any of:
items[].​domain.​namestringrequired
items[].​recipientstring
items[].​recipient-domainstring
items[].​recipient-providerstring
items[].​envelopegithub.com-mailgun-logs-api-pkg-api-model-Envelope (object) or null
Any of:
items[].​storagegithub.com-mailgun-logs-api-pkg-api-model-Storage (object) or null
Any of:
items[].​templategithub.com-mailgun-logs-api-pkg-api-model-Template (object) or null
Any of:
items[].​log-levelstring
items[].​user-variablesstring
items[].​messagegithub.com-mailgun-logs-api-pkg-api-model-Message (object) or null
Any of:
items[].​flagsgithub.com-mailgun-logs-api-pkg-api-model-Flags (object) or null
Any of:
items[].​primary-dkimstring
items[].​ipstring
items[].​geolocationgithub.com-mailgun-logs-api-pkg-api-model-GeoLocation (object) or null
Any of:
items[].​client-infogithub.com-mailgun-logs-api-pkg-api-model-ClientInfo (object) or null
Any of:
items[].​severitystring
items[].​reasonstring
items[].​routesgithub.com-mailgun-logs-api-pkg-api-model-Routes (object) or null
Any of:
items[].​mailing-listgithub.com-mailgun-logs-api-pkg-api-model-MailingList (object) or null
Any of:
items[].​urlstring
paginationobject(github.com-mailgun-logs-api-pkg-api-model-PagingResponse)required
pagination.​previousstring

Token to previous page

pagination.​nextstring

Token to next page

pagination.​firststring

Token to first page

pagination.​laststring

Token to last page

pagination.​totalinteger(int64)

Total number of items

aggregatesobject(github.com-mailgun-logs-api-pkg-api-model-Aggregates)
Response
application/json
{
 "start": "Mon, 08 Jul 2024 00:00:00 -0000",
 "end": "Fri, 12 Jul 2024 00:00:00 -0000",
 "items": [
 { … }
 ],
 "pagination": {
 "previous": "cjsijbijewbu78t678tVTYUYU76754fyuiksi23h75",
 "next": "cjsijbijewbu78t678tVTYUYU76754fyuiksin98hh",
 "first": "cjsijbijewbu78t678tVTYUYU76754fyuiksin865g",
 "last": "875bunjnWkmis75bjklnsdk0s7jksnjknlknc64aTR",
 "total": 100
 },
 "aggregates": {}
}

Bounce Classification

Operations

Tags New

Mailgun allows you to tag your email with unique identifiers. Tags are visible via our analytics tags API endpoint.

Operations

Stats

Mailgun collects many different events and generates event statistics which are available in your Control Panel. This data is also available via our stats API endpoint.

WARNING: This API is deprecated in favor of our Metrics API.

Operations

Tags

Mailgun lets you tag each outgoing message with a custom value. When you access stats on your messages, they will be aggregated by these tags.

WARNING: This API is deprecated in favor of our new Tags API.

Operations

Events

Mailgun keeps track of every inbound and outbound message event and stores this data for at least 3 days.

WARNING: This API is deprecated in favor of our Logs API.

Operations

Send Alerts

Mailgun allows you to get instant notifications on the sending metrics that matter most, configured specifically for your unique business needs and assets. Route these alerts to the channels your team relies on. Stay on top of sending performance without the need to manually monitor.

Operations

Alerts

Operations

Limits

Mailgun allows you to set limits on your subaccounts to help you manage usage and costs. You can create, update, retrieve, and delete limits for various pre-send features such as email previews and email validations.

Operations

Unsubscribe

Unsubscribe list stores email addresses of recipients who unsubscribed from your mailings by clicking a Mailgun generated unsubscribe link.

Operations

Complaints

Email addresses of recipients who marked your messages as a spam (for ESPs that support FBL).

Operations

Bounces

Bounces - Bounce list stores events of delivery failures due to permanent recipient mailbox errors such as non-existent mailbox. Soft bounces (for example, mailbox is full) and other failures (for example, ESP rejects an email because it thinks it is spam) are not added to the list.

Operations

Allowlist

The allowlist API provides the ability to allowlist specific addresses from being added to bounce list. You can allowlist by domain name (i.e example.com) or by specific address (i.e. alice@example.com). Mailgun doesn’t add an address to bounce list if the address is allowlisted. This API is very useful if you test against your private services and don’t want to constantly clean up bounce lists

Operations

Routes

Define a list of routes to handle incoming emails. When a message matches a route expression, Mailgun can forward it on to your application via HTTP or another email address, or store the message temporarily (3 days) for subsequent retrieval.

Operations

Forwards

This API allows you to manage forwarding of incoming emails.

Operations

Mailing Lists

Programatically create mailing lists.

Operations

Account Templates

This API allows you to store predefined templates at the account level and use them to send messages using the Sending API.

Operations

Domain Templates

This API allows you to store predefined templates at the domain level and use them to send messages using the Sending API.

Operations

IP Pools

IP Pools allow you to group your dedicated IPs into customized "pools" to help manage your sending reputation for different mail sending streams.

Operations

Dynamic IP Pools

Dynamic IP Pools allow you to group your dedicated IPs into customized "pools" based on sender reputation. Domains enrolled in Dynamic IP Pools will be assigned to a pool based on the result of periodic health checks.

Operations

IPs

The IP API endpoint allows you to access information regarding the IPs allocated to your Mailgun account that are used for outbound sending.

Operations

IP Address Warmup

Operations

Subaccounts

Mailgun supports the creation, modification, and deletion of subaccounts. A subaccount is a child account of a parent account. The parent account can have multiple subaccounts. The subaccounts are created and managed by the parent account.

Operations

Custom Message Limit

The custom message limit imposes a hard limit on how many messages your account can send during a calendar month.

Operations

Account Management

Perform account-level CRUD operations.

Operations

Keys

The Keys API lets you view and manage API keys.

Operations

Credentials

The Credentials API lets you view and manage SMTP credentials.

Operations

IP Allowlist

The IP Allowlist API lets you view and manage allowlisted IP addresses to which API key and SMTP credential usage is restricted.

Operations

Users

Mailgun API supports viewing user entities.

Operations