List Email Health score and rates grouped by domains/ips/subaccounts/timestamps

Request

Security

basicAuth

Query

include_subaccountsboolean

Include subaccounts

Default:true

skipinteger

Skips N items in a response.

Default:0

limitinteger, [ 1 .. 100 ]

Limits the number of items returned in a response.

Default:10

groupstring

The key to group score by.

Default:"domain"

Enum Value	Description
domain	Group by domain
ip	Group by IP
subaccount	Group by subaccount
timestamp	Group by timestamp in 'YYYY-MM-DD' format

termArray of strings

Filter (exact match) by account_id/domain/ip, e.g.: 'domain:example.com'

querystring

Query filter (fuzzy), e.g.: 'domain:example.com'

sortstring

Supports the following syntax 'sort=field:direction'. 'direction' must be one of asc, desc. Default 'direction' is asc.

Enum Value	Description
domain:asc	domain:asc
domain:desc	domain:desc
ip:asc	ip:asc
ip:desc	ip:desc
subaccount:asc	subaccount:asc
subaccount:desc	subaccount:desc
timestamp:asc	timestamp:asc
timestamp:desc	timestamp:desc
score:asc	score:asc
score:desc	score:desc
bounce_rate:asc	bounce_rate:asc
bounce_rate:desc	bounce_rate:desc
complaint_rate:asc	complaint_rate:asc
complaint_rate:desc	complaint_rate:desc
trap_rate:asc	trap_rate:asc
trap_rate:desc	trap_rate:desc
full_mailbox_rate:asc	full_mailbox_rate:asc
full_mailbox_rate:desc	full_mailbox_rate:desc
bad_failure_rate:asc	bad_failure_rate:asc
bad_failure_rate:desc	bad_failure_rate:desc
delivered:asc	delivered:asc
delivered:desc	delivered:desc

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v1/maverick-score/grouped?include_subaccounts=true&skip=0&limit=10&group=domain&term=string&query=string&sort=domain%3Aasc'

Responses

A 200 response

Bodyapplication/json

itemsArray of objects(Maverick_Score_github.com-mailgun-maverick-score-internal-api-GroupScore)required

totalinteger, (int64)required

Response

{
  "items": [
    { … }
  ],
  "total": 1
}