Engagement

Get deliveries by domain for a period

GET https://api.smtpd.dev/api/v1/analysis/engagement/delivery/domain/summary?from=1&to=2

Path Parameters

Name	Type	Description
Authentication*	string	Bearer {access_token}

Query Parameters

Name	Type	Description
from	number	Unix Timestamp (epoch) in milliseconds - defaults to current time minus 31 days * Max range between from and to is 365 days
to	number	Unix Timestamp (epoch) in milliseconds - defaults to the current time

200

{
  "total": 1075,
  "group_by": {
    "gmail.com": 669,
    "hotmail.com": 406
  },
  "period": {
    "from": 2039823098,
    "to": 234987234
  }
}

Get engagement (Open + Clicks) by country for a period

GET https://api.smtpd.dev/api/v1/analysis/engagement/country/summary?from=1&to=2

Path Parameters

Name	Type	Description
Authentication*	string	Bearer {access_token}

Query Parameters

Name	Type	Description
from	number	Unix Timestamp (epoch) in milliseconds - defaults to current time minus 31 days * Max range between from and to is 365 days
to	number	Unix Timestamp (epoch) in milliseconds - defaults to the current time

200

{
  "total": 1075,
  "group_by": {
    "Australia": 669,
    "United States": 404,
    "unknown": 2
  },
  "period": {
    "from": 2039823098,
    "to": 234987234
  }
}

Get engagement (Open + Clicks) by device type for a period

GET https://api.smtpd.dev/api/v1/analysis/engagement/device/summary?from=1&to=2

Path Parameters

Name	Type	Description
Authentication	string	Bearer {access_token}

Query Parameters

Name	Type	Description
from	number	Unix Timestamp (epoch) in milliseconds - defaults to current time minus 31 days * Max range between from and to is 365 days
to	number	Unix Timestamp (epoch) in milliseconds - defaults to the current time

200

{
  "total": 1075,
  "group_by": {
    "desktop": 669,
    "mobile": 404,
    "unknown": 2
  },
  "period": {
    "from": 2039823098,
    "to": 234987234
  }
}