Skip to content

List statistic v2

Request

Items that have no bounces and no delays(classified_failures_count==0) are not returned.

Security
basicAuth
Bodyapplication/jsonrequired
startobject(github.com-mailgun-holster-v4-clock-RFC822Time)

A start timestamp (default: 7 days before current time). Must be in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format

endobject(github.com-mailgun-holster-v4-clock-RFC822Time)

An end timestamp (default: current time). Must be in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format

resolutionobject(github.com-mailgun-bounce-classification-entities-Resolution)

Resolution of the metrics.

Enum ValueDescription
day

Day

hour

Hour

durationstring

A duration in the format of '48h' '60m' '30s'. If duration is provided then it is calculated from the end date and overwrites the start date.

dimensionsArray of strings

Dimensions.

metricsArray of strings

Metrics to return. See example.

filterobject(github.com-mailgun-bounce-classification-internal-api-FilterPredicateGroup)

Filters to apply to the query.

include_subaccountsboolean

Include stats from all subaccounts.

paginationobject(github.com-mailgun-bounce-classification-internal-api-PaginationReq)

Attributes used for pagination and sorting.

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.mailgun.net/v2/bounce-classification/metrics \
  -H 'Content-Type: application/json' \
  -d '{
    "start": "Sun, 01 Jan 2006 22:04:05 UTC",
    "end": "Mon, 02 Jan 2006 22:04:05 UTC",
    "resolution": "day",
    "duration": "24h0m0s",
    "dimensions": [
      "entity-name",
      "domain.name"
    ],
    "metrics": [
      "critical_bounce_count",
      "non_critical_bounce_count",
      "critical_delay_count",
      "non_critical_delay_count",
      "delivered_smtp_count",
      "classified_failures_count",
      "critical_bounce_rate",
      "non_critical_bounce_rate",
      "critical_delay_rate",
      "non_critical_delay_rate"
    ],
    "filter": {
      "AND": [
        {
          "attribute": "domain.name",
          "comparator": "=",
          "values": [
            {
              "value": "example.com"
            }
          ]
        }
      ]
    },
    "include_subaccounts": true,
    "pagination": {
      "sort": "entity-name:asc",
      "limit": 10
    }
  }'

Responses

A 200 response

Bodyapplication/json
startstringrequired

A start timestamp in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format

endstringrequired

An end timestamp in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format

resolutionobject(github.com-mailgun-bounce-classification-entities-Resolution)required

'resolution' from the request

Enum ValueDescription
day

Day

hour

Hour

durationstring

'duration' from the request

dimensionsArray of strings

'dimensions' from the request

paginationobject(github.com-mailgun-bounce-classification-internal-api-PaginationResp)required
itemsArray of anyrequired
Response
{
  "start": "Sun, 01 Jan 2006 22:04:05 +0000",
  "end": "Mon, 02 Jan 2006 22:04:05 +0000",
  "resolution": "day",
  "duration": "24h0m0s",
  "dimensions": [
    "entity-name",
    "domain.name"
  ],
  "pagination": {
    "sort": "entity-name:asc",
    "limit": 10,
    "total": 1
  },
  "items": [
    { … }
  ]
}