Metrics

Run in Postman
Import the SparkPost API as a Postman collection

SparkPost logs copious amounts of statistical, real-time data about message processing, message disposition, and campaign performance. This reporting data is available in the app (EU) 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.

Data retention

Metrics API data is retained for 6 months.

Terminology

Definitions for terms found in Metrics API

TermDefinition
count_targetedMessages successfully injected into SparkPost as well as rejected by it
count_injectedMessages injected to or received by SparkPost
count_sentMessages that SparkPost attempted to deliver, which includes both Deliveries and Bounces
count_acceptedMessages an ISP or other remote domain accepted (less Out-of-Band Bounces)
count_deliveredMessages delivered
count_delivered_firstMessages delivered on the first attempt
count_delivered_subsequentMessages delivered that required more than one delivery attempt
count_renderedTotal renderings of a message
count_initial_renderedTotal initial renderings of a message
count_unique_renderedTotal number of messages that were rendered at least once
count_unique_initial_renderedTotal number of messages that were initally rendered at least once
count_unique_confirmed_openedTotal number of messages that were rendered or had at least one link selected
count_clickedTotal number of times that links were selected across all messages
count_unique_clickedTotal number of messages which had at least one link selected one or more times
count_bounceTotal number of bounced messages, which includes both In-Band and Out-of-Band bounces
count_hard_bounceTotal number of Bounced messages due to hard bounce classification reasons
count_soft_bounceTotal number of Bounced messages due to soft bounce classification reasons
count_block_bounceTotal number of Bounced messages due to an IP block
count_admin_bounceTotal number of Bounced messages due to admin bounce classification reasons, also includes Rejected
count_undetermined_bounceTotal number of Bounced messages due to undetermined bounce reasons
count_rejectedMessages rejected due to policy or that failed to generate
count_policy_rejectionMessages rejected by SparkPost due to policy
count_generation_failedMessage generation failed for an intended recipient
count_generation_rejectionMessages rejected by SparkPost due to policy
count_inband_bounceMessages that bounced on delivery attempt during the SMTP session
count_outofband_bounceMessages that the ISP bounced subsequent to a successful delivery
count_delayedTotal number of delays due to any temporary failure
count_delayed_firstMessages delayed on the first delivery attempt
total_msg_volumeTotal size of delivered messages, in bytes (including attachments)
count_spam_complaintNumber of spam complaints received from an ISP
total_delivery_time_firstTotal time taken to deliver messages on first attempt (milliseconds)
total_delivery_time_subsequentTotal time taken to delivery messages on subsequent attempts (milliseconds)
count_unsubscribeTotal number of unsubscribes as a result of clicked links and the ISP list unsubscribe feature

Precision Parameter

Agregate Metrics

When the precision parameter is specified for aggregate metric requests, the bounds of the time window (from, to) are rounded to the nearest time matching the precision. For example, requesting data between 4:22 to 6:37 would return results within the following time windows:

PrecisionRounded time window
1min4:22:00 - 6:36:59
5min4:20:00 - 6:39:59
15min4:15:00 - 6:44:59
hour4:00:00 - 6:59:59

All precisions are valid up to a 24 hour time window, except for hour which is also valid up to a 31 day time window.

Time-series Metrics

When the precision parameter is specified for the time-series request, it reflects the period of time the data is grouped by.

Request

GET /api/v1/metrics/

Response

{
  "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"
    }
  ]
}

Discoverability Links

GET/api/v1/metrics/

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.

Deliverability

The deliverability endpoints allow you to get high-level summaries of your data grouped by specific quantifiers such as sending domain or template. You can also get specific types of data, such as rejection reason, to better understand your sending.

Use the subaccount field to get metrics about individual subaccounts or set it to 0 to get only the master account's data.

Request

GET /api/v1/metrics/deliverability?from=2018-07-11T08:00&metrics=count_targeted,count_injected,count_rejected,count_sent

Response

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

Metrics Summary

GET/api/v1/metrics/deliverability{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies an alternate delimiter for all included query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

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

Request

GET /api/v1/metrics/deliverability/domain?from=2018-07-11T08:00&metrics=count_targeted,count_injected,count_rejected,count_sent&order_by=count_injected&limit=5

Response

{
  "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
    }
  ]
}

Metrics by Recipient Domain

GET/api/v1/metrics/deliverability/domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone,order_by,limit}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

order_by string

Metric by which to order results.

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

Request

GET /api/v1/metrics/deliverability/sending-ip?from=2018-07-11T08:00&metrics=count_targeted&limit=5&order_by=count_injected

Response

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

Metrics by Sending IP

GET/api/v1/metrics/deliverability/sending-ip{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone,limit,order_by}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

order_by string

Metric by which to order results.

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

Request

GET /api/v1/metrics/deliverability/ip-pool?from=2018-07-11T08:00&metrics=count_targeted&limit=5&order_by=count_injected

Response

{
  "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
    }
  ]
}

Metrics by IP Pool

GET/api/v1/metrics/deliverability/ip-pool{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone,limit,order_by}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

order_by string

Metric by which to order results.

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

Request

GET /api/v1/metrics/deliverability/sending-domain?from=2018-07-11T08:00&metrics=count_targeted&limit=5&order_by=count_injected

Response

{
  "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"
    }
  ]
}

Metrics by Sending Domain

GET/api/v1/metrics/deliverability/sending-domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone,limit,order_by}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

order_by string

Metric by which to order results.

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

Request

GET /api/v1/metrics/deliverability/subaccount?from=2018-07-11T08:00&metrics=count_targeted&limit=5&order_by=count_injected

Response

{
  "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
    }
  ]
}

Metrics by Subaccount

GET/api/v1/metrics/deliverability/subaccount{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone,limit,order_by}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

order_by string

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.

Request

GET /api/v1/metrics/deliverability/campaign?from=2018-07-11T08:00&limit=5

Response

{
  "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
    }
  ]
}

Metrics by Campaign

GET/api/v1/metrics/deliverability/campaign{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone,limit,order_by}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

order_by string

Metric by which to order results.

Sample string required

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

Request

GET /api/v1/metrics/deliverability/template?from=2018-07-11T08:00&limit=5&order_by=count_injected

Response

{
  "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
    }
  ]
}

Metrics by Template

GET/api/v1/metrics/deliverability/template{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone,limit,order_by}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

order_by string

Metric by which to order results.

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

Request

GET /api/v1/metrics/deliverability/watched-domain?from=2018-07-11T08:00&limit=5&order_by=count_injected

Response

{
  "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
    }
  ]
}

Metrics by Watched Domain

GET/api/v1/metrics/deliverability/watched-domain{?from,to,delimiter,domains,campaigns,templates,sending_ips,ip_pools,sending_domains,subaccounts,precision,metrics,timezone,limit,order_by}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum, default is 1min

Precision of the time window (from, to) bounds. All values valid up to a 24 hour window, except for hour which is also valid up a 31 day window. See: Precision Parameter.

Possible Values: 1min, 5min, 15min, hour

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

order_by string

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.

Request

GET /api/v1/metrics/deliverability/time-series?from=2018-07-11T07:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=summerSale,promotionX&ip_pools=ip-pool-1,ip-pool-2,ip-pool-3&precision=day&timezone=America/New_York

Response

{
  "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
    }
  ]
}

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}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains string

Delimited list of domains for filtering.

campaigns list

Delimited list of campaigns for filtering.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

precision enum

Precision of timeseries data returned.

Possible Values: 1min, 5min, 15min, hour, 12hr, day, week, month

metrics list required

Delimited list of metrics for filtering.

Possible 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 string, default is UTC

Standard timezone identification string.

Provides deliverability metrics ordered by a precision of time.

Request

GET /api/v1/metrics/deliverability/bounce-reason?from=2018-07-11T08:00&limit=5

Response

{
  "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 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}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

metrics list required

Delimited list of metrics to include.

Possible Values: count_bounce, count_inband_bounce, count_outofband_bounce, count_admin_bounce

timezone string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

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

Request

GET /api/v1/metrics/deliverability/bounce-reason/domain?from=2018-07-11T08:00&limit=5

Response

{
  "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 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}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

metrics list required

Delimited list of metrics to include.

Possible Values: count_bounce, count_inband_bounce, count_outofband_bounce, count_admin_bounce

timezone string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

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

Request

GET /api/v1/metrics/deliverability/bounce-classification?from=2018-07-11T08:00&limit=5

Response

{
  "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
    }
  ]
}

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}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

timezone string, default is UTC

Standard timezone identification string.

metrics list required

Delimited list of metrics to include.

Possible Values: count_bounce, count_inband_bounce, count_outofband_bounce, count_admin_bounce

limit int

Maximum number of results to return.

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

Request

GET /api/v1/metrics/deliverability/rejection-reason?from=2018-07-11T08:00&limit=5

Response

{
  "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 Reason Metrics

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

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

timezone string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

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

Request

GET /api/v1/metrics/deliverability/rejection-reason/domain?from=2018-07-11T08:00&limit=5

Response

{
  "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"
    }
  ]
}

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}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

timezone string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

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

Request

GET /api/v1/metrics/deliverability/delay-reason?from=2018-07-11T08:00&limit=5

Response

{
  "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 Reason Metrics

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

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

timezone string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

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

Request

GET /api/v1/metrics/deliverability/delay-reason/domain?from=2018-07-11T08:00&limit=5

Response

{
  "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
    }
  ]
}

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}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

timezone string, default is UTC

Standard timezone identification string.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

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

Request

GET /api/v1/metrics/deliverability/link-name?from=2014-07-11T09:00&metrics=count_clicked,count_raw_clicked&limit=5

Response

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

Engagement Details

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

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

timezone string, default is UTC

Standard timezone identification string.

metrics list required

Delimited list of metrics to include.

Possible Values: count_clicked, count_raw_clicked

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_domains list

Delimited list of sending domains to include.

subaccounts list

Delimited list of subaccount IDs to include.

limit int

Maximum number of results to return between 1 and 10000, inclusive.

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.

Request

GET /api/v1/metrics/deliverability/attempt?from=2018-07-11T08:00&bindings=Confirmation

Response

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

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}

Parameters

from datetime required

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

delimiter string, default is ,

Specifies the delimiter for query parameter lists.

domains list

Delimited list of recipient domains to include.

campaigns list

Delimited list of campaigns to include.

templates list

Delimited list of template IDs to include.

sending_ips list

Delimited list of sending IPs to include.

ip_pools list

Delimited list of IP pools to include.

sending_domains list

Delimited list of sending domains to include.

bindings list

Enterprise delimited list of bindings to include.

binding_groups list

Enterprise delimited list of binding groups to include.

subaccounts list

Delimited list of subaccount IDs to include.

timezone string, default is UTC

Standard timezone identification string.

Provides aggregate count of deliveries grouped by the attempt number.

Request

GET /api/v1/metrics/deliverability/binding{?from,to,delimiter,domains,campaigns,templates,bindings,binding_groups,subaccounts,metrics,timezone,limit,order_by}

Metrics by Binding

GET/api/v1/metrics/deliverability/binding{?from,to,delimiter,domains,campaigns,templates,bindings,binding_groups,subaccounts,metrics,timezone,limit,order_by}

Request

GET /api/v1/metrics/deliverability/binding-group{?from,to,delimiter,domains,campaigns,templates,bindings,binding_groups,subaccounts,metrics,timezone,limit,order_by}

Metrics by Binding Group

GET/api/v1/metrics/deliverability/binding-group{?from,to,delimiter,domains,campaigns,templates,bindings,binding_groups,subaccounts,metrics,timezone,limit,order_by}

Lists

Each of the the following endpoints returns a list of their resources for which we have metrics. These help you get an overview of what metrics are available to you.

Request

GET /api/v1/metrics/ip-pools?from=2017-12-01T08:00&to=2017-12-01T09:00&limit=5

Response

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

IP Pools

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

Parameters

match string

Only return results containing this string.

limit int

Maximum number of results to return.

from datetime

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

timezone string, default is UTC

Standard timezone identification string.

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

Request

GET /api/v1/metrics/sending-ips?from=2017-12-01T08:00&to=2017-12-01T09:00&limit=5

Response

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

Sending IPs

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

Parameters

match string

Only return results containing this string.

limit int

Maximum number of results to return.

from datetime

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

timezone string, default is UTC

Standard timezone identification string.

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

Request

GET /api/v1/metrics/campaigns?from=2017-12-01T08:00&to=2017-12-01T09:00&limit,

Response

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

Campaigns

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

Parameters

match string

Only return results containing this string.

limit int

Maximum number of results to return.

from datetime

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

timezone string, default is UTC

Standard timezone identification string.

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

Request

GET /api/v1/metrics/domains?from=2017-12-01T08:00&to=2017-12-01T09:00&limit,

Response

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

Domains

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

Parameters

match string

Only return results containing this string.

limit int

Maximum number of results to return.

from datetime

Datetime in format of YYYY-MM-DDTHH:MM.

to datetime

Datetime in format of YYYY-MM-DDTHH:MM.

timezone string, default is UTC

Standard timezone identification string.

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

Request

GET /api/v1/metrics/binding-groups{?from,to,timezone,match,limit}

Bindings Groups

GET/api/v1/metrics/binding-groups{?from,to,timezone,match,limit}

Request

GET /api/v1/metrics/bindings{?from,to,timezone,match,limit}

Bindings

GET/api/v1/metrics/bindings{?from,to,timezone,match,limit}