Metrics

SparkPost logs copious amounts of statistical, real-time data about message processing, message disposition, and campaign performance. This reporting data is available in the UI or through the Metrics API. The Metrics API provides a variety of endpoints enabling you to retrieve a summary of the data, data grouped by a specific qualifier, or data by event type. Within each endpoint, you can also apply various filters to drill down to the data for your specific reporting needs.

Deprecation Notice: The bindings and binding_groups query parmeters have been deprecated. Please use the sending_ips and ip_pools query parameters instead.

Data retention

Metrics API data is retained for 6 months.

Using Postman

If you use Postman you can click the following button to import the SparkPost API as a collection:

Run in Postman

Metrics API Deliverability Glossary

Definitions for terms found in Metrics API

Term Definition
count_targeted Messages successfully injected into SparkPost as well as rejected by it
count_injected Messages injected to or received by SparkPost
count_sent Messages that SparkPost attempted to deliver, which includes both Deliveries and In-Band Bounces
count_accepted Messages an ISP or other remote domain accepted (less Out-of-Band Bounces)
count_delivered Messages delivered
count_delivered_first Messages delivered on the first attempt
count_delivered_subsequent Messages delivered that required more than one delivery attempt
count_rendered Total renderings of a message
count_unique_rendered Total number of messages that were rendered at least once
count_unique_confirmed_opened Total number of messages that were rendered or had at least one link selected
count_clicked Total number of times that links were selected across all messages
count_unique_clicked Total number of messages which had at least one link selected one or more times
count_bounce Total number of bounced messages, which includes both In-Band and Out-of-Band bounces
count_hard_bounce Total number of Bounced messages due to hard bounce classification reasons
count_soft_bounce Total number of Bounced messages due to soft bounce classification reasons
count_block_bounce Total number of Bounced messages due to an IP block
count_admin_bounce Total number of Bounced messages due to admin bounce classification reasons, also includes Rejected
count_undetermined_bounce Total number of Bounced messages due to undetermined bounce reasons
count_rejected Messages rejected due to policy or that failed to generate
count_policy_rejection Messages rejected by SparkPost due to policy
count_generation_failed Message generation failed for an intended recipient
count_generation_rejection Messages rejected by SparkPost due to policy
count_inband_bounce Messages that bounced on delivery attempt during the SMTP session
count_outofband_bounce Messages that the ISP bounced subsequent to a successful delivery
count_delayed Total number of delays due to any temporary failure
count_delayed_first Messages delayed on the first delivery attempt
total_msg_volume Total size of delivered messages, in bytes (including attachments)
count_spam_complaint Number of spam complaints received from an ISP
total_delivery_time_first Total time taken to deliver messages on first attempt (milliseconds)
total_delivery_time_subsequent Total time taken to delivery messages on subsequent attempts (milliseconds)
Note: For a given request, average first attempt delivery latency can be calculated as total_delivery_time_first / count_delivered. A similar calculation holds for total_delivery_time_subsequent.

The Metrics API is designed for discoverability of child links. Calling the API root displays a list of URIs that exists within the Metrics API.

GET/api/v1/metrics/

Provides links to all child URIs within the Metrics API.

SparkPost Enterprise customers only: Metric discoverability links for binding-groups and bindings apply to SparkPost Enterprise customers only.

Examples

Request

GET /api/v1/metrics/

Response (HTTP status code: 200)

{
  "results": {},
  "links": [
    {
      "href": "/api/v1/metrics/",
      "rel": "",
      "method": "GET"
    },
    {
      "href": "/api/v1/metrics/campaigns",
      "rel": "campaigns",
      "method": "GET"
    },
    {
      "href": "/api/v1/metrics/deliverability",
      "rel": "deliverability",
      "method": "GET"
    },
    {
      "href": "/api/v1/metrics/domains",
      "rel": "domains",
      "method": "GET"
    },
    {
      "href": "/api/v1/metrics/binding-groups",
      "rel": "binding-groups",
      "method": "GET"
    },
    {
      "href": "/api/v1/metrics/bindings",
      "rel": "bindings",
      "method": "GET"
    },
    {
      "href": "/api/v1/metrics/ip-pools",
      "rel": "ip-pools",
      "method": "GET"
    },
    {
      "href": "/api/v1/metrics/sending-ips",
      "rel": "sending-ips",
      "method": "GET"
    }
  ]
}

Deliverability Metrics

Deliverability Metrics Summary

GET/api/v1/metrics/deliverability{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone}
URI Parameters
from(required)  

Datetime in format of YYYY-MM-DDTHH:MM

Example: 2014-07-11T08:00
to

Datetime in format of YYYY-MM-DDTHH:MM

Default: now

Example: 2014-07-20T09:00
delimiter

Specifies an alternate delimiter for all included query parameter lists

Default: ,

domains

delimited list of domains to include

Example: gmail.com,yahoo.com,hotmail.com
campaigns

delimited list of campaigns to include

Example: Black Friday
templates

delimited list of template IDs to include

Example: summer-sale
sending_ips

delimited list of sending IPs to include

Example: 123.456.789.123,123.456.789.124
ip_pools

delimited list of IP pools to include

Example: Transaction
sending_domains

delimited list of sending domains to include

Example: sales.sender.com,company.net
subaccounts

delimited list of subaccount ids to include
Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

Example: 123,125,127
metrics(required)  

delimited list of metrics for filtering

Example: count_targeted,count_injected,count_rejected,count_sent
Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York

    Provides high-level summary of aggregate metrics and lists the child endpoints that contain aggregate data, which can be used as “group by” qualifiers.

    Examples

    Request

    GET /api/v1/metrics/deliverability?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=count_targeted,count_injected,count_rejected,count_sent&timezone=America/New_York

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        }
      ],
      "links": [
        {
          "href": "/api/v1/metrics/deliverability",
          "rel": "deliverability",
          "method": "GET"
        }
      ]
    }

    Deliverability Metrics by Domain

    Deliverability Metrics by Domain

    GET/api/v1/metrics/deliverability/domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics for filtering

    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5
    order_by (optional, string, `count_injected`)(required)  

    Metric by which to order results

    Provides aggregate metrics grouped by domain over the time window specified.

    Examples

    Request

    GET /api/v1/metrics/deliverability/domain?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "domain": "aol.com",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        },
        {
          "domain": "foo.net",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        }
      ]
    }

    Deliverability Metrics by Binding

    Deprecation Notice: This endpoint has been deprecated. Please use the Deliverability Metrics by Sending IP endpoint instead.

    Deliverability Metrics by Binding

    GET/api/v1/metrics/deliverability/binding

    Examples


    Deliverability Metrics by Binding Group

    Deprecation Notice: This endpoint has been deprecated. Please use the Deliverability Metrics by IP Pool endpoint instead.

    Deliverability Metrics by Binding Group

    GET/api/v1/metrics/deliverability/binding-group

    Examples


    Deliverability Metrics by Sending IP

    Deliverability Metrics by Sending IP

    GET/api/v1/metrics/deliverability/sending-ip{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics for filtering

    Example: count_targeted
    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5
    order_by (optional, string, `count_injected`)(required)  

    Metric by which to order results

    Provides aggregate metrics grouped by sending IP over the time window specified.

    Examples

    Request

    GET /api/v1/metrics/deliverability/sending-ip?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=count_targeted&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    Empty response body

    Deliverability Metrics by IP Pool

    Deliverability Metrics by IP Pool

    GET/api/v1/metrics/deliverability/ip-pool{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics for filtering

    Example: count_targeted
    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5
    order_by (optional, string, `count_injected`)(required)  

    Metric by which to order results

    Provides aggregate metrics grouped by IP pool over the time window specified.

    Examples

    Request

    GET /api/v1/metrics/deliverability/ip-pool?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=count_targeted&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "ip_pool": "ip-pool-0",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        },
        {
          "ip_pool": "ip-pool-1",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        }
      ]
    }

    Deliverability Metrics by Sending Domain

    Deliverability Metrics by Sending Domain

    GET/api/v1/metrics/deliverability/sending-domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics for filtering

    Example: count_targeted
    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5
    order_by (optional, string, `count_injected`)(required)  

    Metric by which to order results

    Provides aggregate metrics grouped by sending domain over the time window specified.

    Examples

    Request

    GET /api/v1/metrics/deliverability/sending-domain?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=count_targeted&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "sending_domain": "foo.example.com"
        },
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "sending_domain": "bar.example.com"
        },
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "sending_domain": "bat.example.com"
        },
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "sending_domain": "baz.example.com"
        }
      ]
    }

    Deliverability Metrics by Subaccount

    Deliverability Metrics by Subaccount

    GET/api/v1/metrics/deliverability/subaccount{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics for filtering

    Example: count_targeted
    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5
    order_by (optional, string, `count_injected`)(required)  

    Metric by which to order results

    Provides aggregate metrics grouped by subaccount over the time window specified. Please note that master account events will be returned grouped by the subaccount_id field containing the value 0.

    Examples

    Request

    GET /api/v1/metrics/deliverability/subaccount?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=count_targeted&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "subaccount_id": 0
        },
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "subaccount_id": 123
        },
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "subaccount_id": 125
        },
        {
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "subaccount_id": 127
        }
      ]
    }

    Deliverability Metrics by Campaign

    Deliverability Metrics by Campaign

    GET/api/v1/metrics/deliverability/campaign{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics for filtering

    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5
    order_by (optional, string, `count_injected`)(required)  

    Metric by which to order results

    Provides aggregate metrics grouped by campaign over the time window specified.

    Examples

    Request

    GET /api/v1/metrics/deliverability/campaign?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "campaign_id": "campaign-0",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        },
        {
          "campaign_id": "campaign-1",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        }
      ]
    }

    Deliverability Metrics by Template

    Deliverability Metrics by Template

    GET/api/v1/metrics/deliverability/template{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics for filtering

    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5
    order_by (optional, string, `count_injected`)(required)  

    Metric by which to order results

    Provides aggregate metrics grouped by template over the time window specified.

    Examples

    Request

    GET /api/v1/metrics/deliverability/template?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "template_id": "template-0",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        },
        {
          "template_id": "template-1",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        }
      ]
    }

    Deliverability Metrics by Watched Domain

    Deliverability Metrics by Watched Domain

    GET/api/v1/metrics/deliverability/watched-domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    metrics(required)  

    delimited list of metrics for filtering

    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5
    order_by (optional, string, `count_injected`)(required)  

    Metric by which to order results

    Provides aggregate metrics grouped by watched domain over the time window specified. The difference between domain and watched domain is that watched domains are comprised of the top 99% domains in the world.

    Examples

    Request

    GET /api/v1/metrics/deliverability/watched-domain?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "watched_domain": "aol.com",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        },
        {
          "watched_domain": "gmail.com",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344
        }
      ]
    }

    Time Series

    Time-Series Metrics

    GET/api/v1/metrics/deliverability/time-series{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T07:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T08:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains for filtering

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns for filtering

    Example: summerSale,promotionX
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: ip-pool-1,ip-pool-2,ip-pool-3
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    precision

    Precision of timeseries data returned

    Example: day
    Values:
  • 1min,
  • 5min,
  • 15min,
  • hour,
  • 12hr,
  • day,
  • week,
  • month,
  • metrics(required)  

    delimited list of metrics for filtering

    Values:
  • count_injected,
  • count_bounce,
  • count_rejected,
  • count_delivered,
  • count_delivered_first,
  • count_delivered_subsequent,
  • total_delivery_time_first,
  • total_delivery_time_subsequent,
  • total_msg_volume,
  • count_policy_rejection,
  • count_generation_rejection,
  • count_generation_failed,
  • count_inband_bounce,
  • count_outofband_bounce,
  • count_soft_bounce,
  • count_hard_bounce,
  • count_block_bounce,
  • count_admin_bounce,
  • count_undetermined_bounce,
  • count_delayed,
  • count_delayed_first,
  • count_rendered,
  • count_unique_rendered,
  • count_unique_confirmed_opened,
  • count_clicked,
  • count_unique_clicked,
  • count_targeted,
  • count_sent,
  • count_accepted,
  • count_spam_complaint,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York

    Provides deliverability metrics ordered by a precision of time.

    The following table describes the validation for the precision parameter:

    Value of Valid for time window of
    1min, 5min day
    hour month
    day, month any

    Examples

    Request

    GET /api/v1/metrics/deliverability/time-series?from=2014-07-11T07:00&to=2014-07-20T08:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=summerSale,promotionX&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=ip-pool-1,ip-pool-2,ip-pool-3&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&precision=day&metrics=&timezone=America/New_York

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "ts": "2013-09-06T09:30",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "count_delivered": 3434,
          "count_delivered_first": 343,
          "count_delivered_subsequent": 22323,
          "total_msg_volume": 33434,
          "count_inband_bounce": 2,
          "count_outofband_bounce": 2,
          "count_bounce": 2,
          "count_soft_bounce": 8,
          "count_hard_bounce": 6,
          "count_block_bounce": 4,
          "count_admin_bounce": 2,
          "count_undetermined_bounce": 2,
          "count_accepted": 3434,
          "count_delayed": 2,
          "count_generation_failed": 1,
          "count_generation_rejection": 1,
          "count_delayed_first": 5,
          "count_rendered": 111,
          "count_unique_rendered": 111,
          "count_unique_confirmed_opened": 111,
          "count_clicked": 8,
          "count_unique_clicked": 8,
          "count_spam_complaint": 5
        },
        {
          "ts": "2013-09-06T09:29",
          "count_targeted": 34432,
          "count_injected": 32323,
          "count_rejected": 2343,
          "count_sent": 34344,
          "count_delivered": 3434,
          "count_delivered_first": 343,
          "count_delivered_subsequent": 22323,
          "total_msg_volume": 33434,
          "count_inband_bounce": 2,
          "count_outofband_bounce": 2,
          "count_bounce": 2,
          "count_soft_bounce": 8,
          "count_hard_bounce": 6,
          "count_block_bounce": 4,
          "count_admin_bounce": 2,
          "count_undetermined_bounce": 2,
          "count_accepted": 3434,
          "count_delayed": 2,
          "count_generation_failed": 1,
          "count_generation_rejection": 1,
          "count_delayed_first": 5,
          "count_rendered": 111,
          "count_unique_rendered": 111,
          "count_unique_confirmed_opened": 111,
          "count_clicked": 8,
          "count_unique_clicked": 8,
          "count_spam_complaint": 7
        }
      ]
    }

    Bounce Reasons

    Bounce Reason Metrics

    GET/api/v1/metrics/deliverability/bounce-reason{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics to include

    Values:
  • count_bounce,
  • count_inband_bounce,
  • count_outofband_bounce,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5

    Provides deliverability metrics, specific to bounce events, grouped by the bounce reasons.

    Examples

    Request

    GET /api/v1/metrics/deliverability/bounce-reason?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "reason": "Some Fake Reason",
          "bounce_class_name": "Undetermined",
          "bounce_class_description": "The response text could not be identified",
          "bounce_category_id": 0,
          "bounce_category_name": "Undetermined",
          "classification_id": 1,
          "count_inband_bounce": 119,
          "count_outofband_bounce": 118,
          "count_bounce": 237
        },
        {
          "reason": "Some Fake Reason",
          "bounce_class_name": "Invalid Recipient",
          "bounce_class_description": "The recipient is invalid",
          "bounce_category_id": 1,
          "bounce_category_name": "Hard",
          "classification_id": 10,
          "count_inband_bounce": 133,
          "count_outofband_bounce": 126,
          "count_bounce": 259
        }
      ]
    }

    Bounce Reasons By Domain

    Bounce Reason Metrics By Domain

    GET/api/v1/metrics/deliverability/bounce-reason/domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    metrics(required)  

    delimited list of metrics to include

    Values:
  • count_bounce,
  • count_inband_bounce,
  • count_outofband_bounce,
  • timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5

    Provides deliverability metrics, specific to bounce events, grouped by the domain and bounce reasons.

    Examples

    Request

    GET /api/v1/metrics/deliverability/bounce-reason/domain?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "reason": "Some Fake Reason",
          "domain": "example.com",
          "bounce_class_name": "Undetermined",
          "bounce_class_description": "The response text could not be identified",
          "bounce_category_id": 0,
          "bounce_category_name": "Undetermined",
          "classification_id": 1,
          "count_inband_bounce": 119,
          "count_outofband_bounce": 118,
          "count_bounce": 237
        },
        {
          "reason": "Some Fake Reason",
          "domain": "aol.com",
          "bounce_class_name": "Invalid Recipient",
          "bounce_class_description": "The recipient is invalid",
          "bounce_category_id": 1,
          "bounce_category_name": "Hard",
          "classification_id": 10,
          "count_inband_bounce": 133,
          "count_outofband_bounce": 126,
          "count_bounce": 259
        }
      ]
    }

    Bounce Classifications

    Bounce Classification Metrics

    GET/api/v1/metrics/deliverability/bounce-classification{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,metrics,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    metrics(required)  

    delimited list of metrics to include

    Values:
  • count_bounce,
  • count_inband_bounce,
  • count_outofband_bounce,
  • limit

    Maximum number of results to return

    Example: 5

    Provides deliverability metrics, specific to bounce events, grouped by the bounce classification. (See Bounce Classification Codes.)

    Examples

    Request

    GET /api/v1/metrics/deliverability/bounce-classification?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&metrics=&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "bounce_class_name": "Undetermined",
          "bounce_class_description": "The response text could not be identified",
          "bounce_category_name": "Undetermined",
          "count_bounce": 226,
          "count_inband_bounce": 205,
          "count_outofband_bounce": 21,
          "classification_id": 1
        },
        {
          "bounce_class_name": "Invalid Recipient",
          "bounce_class_description": "The recipient is invalid",
          "bounce_category_name": "Hard",
          "count_bounce": 249,
          "count_inband_bounce": 224,
          "count_outofband_bounce": 25,
          "classification_id": 10
        }
      ]
    }

    Rejection Reasons

    Rejection Reason Metrics

    GET/api/v1/metrics/deliverability/rejection-reason{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5

    Provides deliverability metrics, specific to rejection events, grouped by the rejection reasons.

    Examples

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "reason": "520 rejection message",
          "count_rejected": 30,
          "rejection_category_id": 2,
          "rejection_type": "Generation Rejection"
        },
        {
          "reason": "503 rejection message",
          "count_rejected": 24,
          "rejection_category_id": 1,
          "rejection_type": "Policy Rejection"
        }
      ]
    }

    Rejection Reasons By Domain

    Rejection Reason Metrics By Domain

    GET/api/v1/metrics/deliverability/rejection-reason/domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5

    Provides deliverability metrics, specific to rejection events, grouped by the domain and rejection reasons.

    Examples

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "reason": "520 rejection message",
          "domain": "example.com",
          "count_rejected": 30,
          "rejection_category_id": 2,
          "rejection_type": "Generation Rejection"
        },
        {
          "reason": "503 rejection message",
          "domain": "aol.com",
          "count_rejected": 24,
          "rejection_category_id": 1,
          "rejection_type": "Policy Rejection"
        }
      ]
    }

    Delay Reasons

    Delay Reason Metrics

    GET/api/v1/metrics/deliverability/delay-reason{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5

    Provides deliverability metrics, specific to delay events, grouped by the delay reasons.

    Examples

    Request

    GET /api/v1/metrics/deliverability/delay-reason?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "reason": "400 fake tempfail reason",
          "count_delayed": 200,
          "count_delayed_first": 100
        },
        {
          "reason": "425 fake tempfail reason",
          "count_delayed": 100,
          "count_delayed_first": 50
        }
      ]
    }

    Delay Reasons By Domain

    Delay Reason Metrics By Domain

    GET/api/v1/metrics/deliverability/delay-reason/domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,timezone,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5

    Provides deliverability metrics, specific to delay events, grouped by the domain and delay reasons.

    Examples

    Request

    GET /api/v1/metrics/deliverability/delay-reason/domain?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&timezone=America/New_York&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "reason": "400 fake tempfail reason",
          "domain": "example.com",
          "count_delayed": 200,
          "count_delayed_first": 100
        },
        {
          "reason": "425 fake tempfail reason",
          "domain": "aol.com",
          "count_delayed": 100,
          "count_delayed_first": 50
        }
      ]
    }

    Engagement Details

    Engagement Details

    GET/api/v1/metrics/deliverability/link-name{?from,to,delimiter,timezone,campaigns,templates,subaccounts,sending_domains,metrics,limit}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T09:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T00:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York
    metrics(required)  

    delimited list of metrics to include

    Values:
  • count_clicked,
  • count_raw_clicked,
  • campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    limit

    Maximum number of results to return within range [1, 10000]

    Default: 1000

    Example: 5

    Provides deliverability metrics, specific to engagement events (clicks/opens), grouped by the link name (or URL if no link name exists). To name the links in your messages, read about the data-msys-link-name HTML attribute here.

    Examples

    Request

    GET /api/v1/metrics/deliverability/link-name?from=2014-07-11T09:00&to=2014-07-20T00:00&delimiter=:&timezone=America/New_York&campaigns=Black Friday&templates=summer-sale&subaccounts=123,125,127&sending_domains=sales.sender.com,company.net&metrics=&limit=5

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "link_name": "top banner link",
          "count_clicked": 123,
          "count_raw_clicked": 456
        },
        {
          "link_name": "Raw URL",
          "count_clicked": 123,
          "count_raw_clicked": 456
        }
      ]
    }

    Deliveries By Attempt

    Deliveries By Attempt

    GET/api/v1/metrics/deliverability/attempt{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,bindings,binding_groups,sending_domains,subaccounts,timezone}
    URI Parameters
    from(required)  

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2014-07-11T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-07-20T09:00
    delimiter

    Specifies the delimiter for query parameter lists

    Default: ,

    Example: :
    domains

    delimited list of domains to include

    Example: gmail.com,yahoo.com,hotmail.com
    campaigns

    delimited list of campaigns to include

    Example: Black Friday
    templates

    delimited list of template IDs to include

    Example: summer-sale
    sending_ips

    delimited list of sending IPs to include

    Example: 123.456.789.123,123.456.789.124
    ip_pools

    delimited list of IP pools to include

    Example: Transaction
    sending_domains

    delimited list of sending domains to include

    Example: sales.sender.com,company.net
    bindings

    Enterprise delimited list of bindings to include

    Example: Confirmation
    binding_groups

    Enterprise delimited list of binding groups to include

    Example: Transaction
    subaccounts

    delimited list of subaccount ids to include
    Note providing ?subaccounts=0 will filter out all subaccount data, and only return master account data

    Example: 123,125,127
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York

    Provides aggregate count of deliveries grouped by the attempt number.

    Examples

    Request

    GET /api/v1/metrics/deliverability/attempt?from=2014-07-11T08:00&to=2014-07-20T09:00&delimiter=:&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&sending_ips=123.456.789.123,123.456.789.124&ip_pools=Transaction&bindings=Confirmation&binding_groups=Transaction&sending_domains=sales.sender.com,company.net&subaccounts=123,125,127&timezone=America/New_York

    Response (HTTP status code: 200)

    {
      "results": [
        {
          "attempt": "1",
          "count_delivered": 100
        },
        {
          "attempt": "2",
          "count_delivered": 150
        }
      ]
    }

    Binding Groups List

    Deprecation Notice: This endpoint has been deprecated. Please use the IP Pools listing endpoint instead.

    Bindings Groups List

    GET/api/v1/metrics/binding-groups

    Examples


    Bindings List

    Deprecation Notice: This endpoint has been deprecated. Please use the Sending IPs listing endpoint instead.

    Bindings List

    GET/api/v1/metrics/bindings

    Examples


    IP Pools List

    IP Pools List

    GET/api/v1/metrics/ip-pools{?from,to,timezone,match,limit}
    URI Parameters
    match

    Only return results containing this string

    Example: example
    limit

    Maximum number of results to return

    Example: 5
    from

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2015-12-01T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-12-01T09:00
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York

    Returns a list of IP pools that the Metrics API contains data on.

    Examples

    Request

    GET /api/v1/metrics/ip-pools?from=2015-12-01T08:00&to=2014-12-01T09:00&timezone=America/New_York&match=example&limit=5

    Response (HTTP status code: 200)

    {
      "results": {
        "ip-pools": [
          "ip-pool-1",
          "ip-pool-2",
          "ip-pool-3",
          "ip-pool-4",
          "ip-pool-5"
        ]
      }
    }

    Sending IPs List

    Sending IPs List

    GET/api/v1/metrics/sending-ips{?from,to,timezone,match,limit}
    URI Parameters
    match

    Only return results containing this string

    Example: example
    limit

    Maximum number of results to return

    Example: 5
    from

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2015-12-01T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-12-01T09:00
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York

    Returns a list of sending IPs that the Metrics API contains data on.

    Examples

    Request

    GET /api/v1/metrics/sending-ips?from=2015-12-01T08:00&to=2014-12-01T09:00&timezone=America/New_York&match=example&limit=5

    Response (HTTP status code: 200)

    {
      "results": {
        "sending-ips": [
          "sending-ip-1",
          "sending-ip-2",
          "sending-ip-3",
          "sending-ip-4",
          "sending-ip-5"
        ]
      }
    }

    Campaigns List

    Campaigns List

    GET/api/v1/metrics/campaigns{?from,to,timezone,limit,match}
    URI Parameters
    match

    Only return results containing this string

    Example: example
    limit

    Maximum number of results to return

    Example: 5
    from

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2015-12-01T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-12-01T09:00
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York

    Returns a list of campaigns that the Metrics API contains data on.

    Examples

    Request

    GET /api/v1/metrics/campaigns?from=2015-12-01T08:00&to=2014-12-01T09:00&timezone=America/New_York&limit=5&match=example

    Response (HTTP status code: 200)

    {
      "results": {
        "campaigns": [
          "Labor Day Sale",
          "New Year's Sale",
          "Founder's Day Event",
          "Winter Event",
          "Promotion X"
        ]
      }
    }

    Domains List

    Domains List

    GET/api/v1/metrics/domains{?from,to,timezone,limit,match}
    URI Parameters
    match

    Only return results containing this string

    Example: example
    limit

    Maximum number of results to return

    Example: 5
    from

    Datetime in format of YYYY-MM-DDTHH:MM

    Example: 2015-12-01T08:00
    to

    Datetime in format of YYYY-MM-DDTHH:MM

    Default: now

    Example: 2014-12-01T09:00
    timezone

    Standard timezone identification string, defaults to UTC

    Default: UTC

    Example: America/New_York

    Returns a list of domains that the Metrics API contains data on.

    Examples

    Request

    GET /api/v1/metrics/domains?from=2015-12-01T08:00&to=2014-12-01T09:00&timezone=America/New_York&limit=5&match=example

    Response (HTTP status code: 200)

    {
      "results": {
        "domains": [
          "gmail.com",
          "yahoo.com",
          "msn.com",
          "aol.com",
          "hotmail.com"
        ]
      }
    }