Retrieve metrics from your Dyn Delivery accounts using the API.

REST Methods

NOTE: API is case sensitive. Make all parameters entries lower case. All parameters in red are required.

VERB RESOURCE PARAMETERS DESCRIPTION
GET /reports/clicks
  • apikey
  • starttime
  • endtime
  • sender
  • emailaddress
  • startindex
  • [X-HeaderName]
  • domain
Returns a list of links clicked for the specified account within a specified date range.
GET /reports/clicks/unique
  • apikey
  • starttime
  • endtime
  • sender
  • emailaddress
  • startindex
  • [X-HeaderName]
  • domain
Returns a list of unique links clicked for the specified account within a specified date range.
GET /reports/clicks/count
  • apikey
  • starttime
  • endtime
  • sender
  • emailaddress
  • [X-HeaderName]
  • domain
Returns total number of links clicked for the specified account within a specified date range.
GET /reports/clicks/count/unique
  • apikey
  • starttime
  • endtime
  • sender
  • emailaddress
  • domain
  • [X-HeaderName]
Returns total number of unique links clicked for the specified account within a specified date range.
GET /reports/opens
  • apikey
  • sender
  • domain
  • emailaddress
  • [X-HeaderName]
  • startindex
Returns a list of all email opens for the specified account within a specified date range.
GET /reports/opens/unique
  • apikey
  • starttime
  • endtime
  • sender
  • domain
  • emailaddress
  • [X-HeaderName]
  • startindex
Returns a list of unique email opens for the specified account for the specified date range.
GET /reports/opens/count
  • apikey
  • starttime
  • endtime
  • sender
  • emailaddress
  • [X-HeaderName]
  • domain
Returns total number of opens for the specified account within the specified date range.
GET /reports/opens/count/unique
  • apikey
  • starttime
  • endtime
  • sender
  • emailaddress
  • [X-HeaderName]
  • domain
Returns total number of unique opens for the specified account within the specified date range.
GET /reports/issues
  • apikey
  • starttime
  • endtime
  • startindex
Returns a list of issues for the specified account within the specified date range.
GET /reports/issues/count
  • apikey
  • starttime
  • endtime
Returns total number of issues concerning the specified account within a specified date range.
GET /reports/complaints
  • apikey
  • starttime
  • endtime
  • sender
  • [X-Header(s)]
  • startindex
Returns a list of SPAM complaints received for the specified account within a specified date range, optionally filtered by sender.
GET /reports/complaints/count
  • apikey
  • starttime
  • endtime
  • sender
Returns total number of SPAM complaints that the specified account received within the specified date range, optionally filtered by sender.
GET /reports/bounces
  • apikey
  • starttime
  • endtime
  • emailaddress
  • sender
  • startindex
  • [X-Header Name]
  • bouncetype
Returns a list of all email bounces received for the specified account and date range, optionally filtered by sender.
GET /reports/bounces/count
  • apikey
  • starttime
  • endtime
  • sender
  • [X-Header Name]
Returns the total number of email bounces for the specified account and date range, optionally filtered by sender.
GET /reports/delivered
  • apikey
  • starttime
  • endtime
  • sender
  • [X-Header Name]
  • startindex
Returns a list of all emails sent through the specified account that were successfully delivered within the specified date range, optionally filtered by sender. Including a date range is recommended.
GET /reports/delivered/count
  • apikey
  • starttime
  • endtime
  • sender
  • [X-Header Name]
Returns total number of emails sent through the specified account that were successfully delivered within the specified date range, optionally filtered by sender. Including a date range is recommended.
GET /reports/sent
  • apikey
  • starttime
  • endtime
  • sender
  • [X-Header Name]
  • startindex
Returns total number of emails sent through the specified account that were successfully sent within the specified date range, optionally filtered by sender. Including a date range is recommended.
GET /reports/sent/count
  • apikey
  • starttime
  • endtime
  • sender
  • [X-Header Name]
Returns the total number of emails sent through the specified account within the specified date range, optionally filtered by sender.
GET /reports/blockedemail
  • apikey
  • starttime
  • endtime
  • emailaddress
  • sender
  • [X-Header Name]
  • startindex
Returns a list of all emails that were blocked from sending due to a suppressed recipient.
GET /reports/blockedemail/count
  • apikey
  • starttime
  • endtime
  • sender
  • [X-Header Name]
Returns the total number of emails that were blocked from sending through the specified account.

 


GET /reports/clicks

Returns a list of links clicked for the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • starttimeRequired. Start date/time range in full, ISO 8601 format
  • endtimeRequired. End date/time range in full, ISO 8601 format
  • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with an empty result.
  • emailaddress — Email address of recipient for filtering.
  • startindex — Starting index value (optional).
  • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
    NOTE: When setting X-Header values, it is important to avoid using the greater than (>) and lesser than (<) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
  • [X-Header(s)]— custom X-Header(s) included with the original email. Note that the system stores and displays up to 500 characters for each X-Header value, for reporting purposes only. X-Headers and their values are kept intact within emails that are processed and sent. NOTE: If an unknown x-header is provided, the value is ignored and not figured into limiting any results.
  • domain — Domain of the recipient, such as “gmail.com” or “comcast.net”

Example Results (JSON)

{
    "response": {
        "status": 200,
        "message": "OK",
        "data": {
            "clicks": [
                {
                    "xheaders": [
                    ],
                    "emailaddress": “example@dyn.com",
                    "ip": "216.146.45.33",
                    "clicklink": "http://example.com”,
                    "date": "2016-01-11T17:53:59+00:00"
                }
            ]
        }
    }
}

GET /reports/clicks/unique

Returns a list of unique links clicked for the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

Method returns a maximum number of 500 email addresses at a time. When the total delivered (as returned by /reports/clicks/count) is more than 500, specify the optional “starting index” parameter repeatedly, incrementing by 500 each time, until all have been retrieved.

  • apikeyRequired. API key of the account with the desired information.
  • starttimeRequired. Start date/time range in full, ISO 8601 format
  • endtimeRequired. End date/time range in full, ISO 8601 format
  • clicklink — The total initial clicks of a link in an email, e.g. if a recipient clicks the same link twice in an email, Dyn will report only one click for that recipient.
  • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with an empty result.
  • emailaddress — Email address of recipient for filtering.
  • startindex — Starting index value (optional).
  • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
    NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
  • emailaddress — Email address of recipient for filtering
  • domain — Domain of the recipient, such as “gmail.com” or “comcast.net”

Example Results (JSON)

{
    "response": {
        "status": 200,
        "message": "OK",
        "data": {
            "clicks": [
                {
                    "xheaders": [
                    ],
                    "emailaddress": “example@dyn.com",
                    "clicklink": "http://example.com”,
                    "count": "1"
                }
            ]
        }
    }
}

GET /reports/clicks/count

Returns total number of links clicked for the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • starttimeRequired. Start date/time range in full, ISO 8601 format.
  • endtimeRequired. End date/time range in full, ISO 8601 format.
  • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with a count of 0.
  • emailaddress — Email address of recipient for filtering.
  • domain — Domain of the recipient, such as “gmail.com” or “comcast.net”
  • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
    NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"count":"5309"}}}

GET /reports/clicks/count/unique

Returns total number of unique links clicked within a specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • starttimeRequired. Start date/time range in full, ISO 8601 format.
  • endtimeRequired. End date/time range in full, ISO 8601 format.
  • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with a count of 0.
  • emailaddress — Email address of recipient for filtering.
  • domain — Domain of the recipient, such as “gmail.com” or “comcast.net”
  • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
    NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”

Example Results (JSON)

{"response":{"status":200,"message":"OK","data":{"count":"5309"}}}

GET /reports/opens

Returns a list of all email opens for the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

Parameters

  • apikeyRequired. API key of the account with the desired information.
  • sender — Email address of sender for filtering. Must be on the current Approved Sender list. if using a GET request, it is best practice to encode special characters such as the “at symbol” (@). An invalid sender value will return a 200 OK response with an empty result.
  • domain — domain of the recipient, such as “gmail.com” or “comcast.net”.
  • emailaddress — Email address of recipient for filtering.
  • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
  • startindex — Number indicating where to begin reporting results.
  • Example Results (JSON)

    {"response":{"status":200,"message":"OK","data":{"opens":[{"ip":"123.12.65.234","stage":"opened","date":"2011-04-08T07:51:03-04:00","emailaddress":"example@domain.com"},…]}}}

    GET /reports/opens/unique

    Returns a list of unique email opens for the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time in full, ISO 8601 format.
    • endtimeRequired. End date/time in full, ISO 8601 format.
    • sender — Email address of sender for filtering. Must be on the current Approved Sender list. if using a GET request, it is best practice to encode special characters such as the “at symbol” (@). An invalid sender value will return a 200 OK response with an empty result.
    • domain — domain of the recipient, such as “gmail.com” or “comcast.net”.
    • emailaddress — Email address of recipient for filtering.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
    • startindex — Number indicating where to begin reporting results.
    • emailaddress — Email address of recipient for filtering
    • [X-Header(s)] — custom X-Header(s) included with the original email. Note that the system stores and displays up to 500 characters for each X-Header value, for reporting purposes only. X-Headers and their values are kept intact within emails that are processed and sent. If an unknown x-header is provided, the value is ignored and not figured into limiting any results.
      NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”

    Example Results (JSON)

    {
        "response": {
            "status": 200,
            "message": "OK",
            "data": {
                "opens": [
                    {
                        "xheaders": [
                        ],
                        "emailaddress": “example@dyn.com",
                        "date": "2016-01-11T17:53:09+00:00",
                        "count": "1"
                    }
                ]
            }
        }
    }
    

    GET reports/opens/count

    Returns total number of opens for the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time in full, ISO 8601 format.
    • endtimeRequired. End date/time in full, ISO 8601 format.
    • sender — Email address of sender for filtering. Must be on the current Approved Sender list. if using a GET request, it is best practice to encode special characters such as the “at symbol” (@). An invalid sender value will return a 200 OK response with a count of 0.
    • emailaddress — Email address of recipient for filtering.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
      NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
    • domain — Domain of the recipient, such as “gmail.com” or “comcast.net”
    {"response":{"status":200,"message":"OK","data":{"count":"867"}}}

    GET /reports/opens/count/unique

    Returns total number of unique opens for the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time in full, ISO 8601 format.
    • endtimeRequired. End date/time in full, ISO 8601 format.
    • sender — Email address of sender for filtering. Must be on the current Approved Sender list. if using a GET request, it is best practice to encode special characters such as the “at symbol” (@). An invalid sender value will return a 200 OK response with a count of 0.
    • emailaddress — Email address of recipient for filtering.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
      NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
    • domain — Domain of the recipient, such as “gmail.com” or “comcast.net”
    {"response":{"status":200,"message":"OK","data":{"count":"867"}}}

    GET /reports/issues

    Returns a list of issues for the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameter

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format
    • endtimeRequired. End date/time range in full, ISO 8601 format
    • startindex — Number indicating where to begin reporting results.

    Example Results (JSON)

    {"response":{"status":200,"message":"OK","data":{"issue":[{"emailaddress":"email@domain.org","issuetime":"1381495268",
    "issue":"\"From\" address not an Approved Sender"}]}}}

    GET /reports/issues/count

    Returns total number of issues concerning the specified account within a specified date range. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    Method returns a maximum number of 500 email addresses at a time. When the total delivered (as returned by /reports/issues/count) is more than 500, specify the optional “starting index” parameter repeatedly, incrementing by 500 each time, until all have been retrieved.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Timestamp for the start of the report.
    • endtimeRequired. Timestamp for the end of the report.

    Example Results (JSON)

    {"response":{"status":200,"message":"OK","data":{"count":"74"}}}

    GET /reports/complaints

    Returns a list of SPAM complaints received for the specified account within a specified date range, optionally filtered by sender. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    Method returns a maximum number of 500 email addresses at a time. When the total delivered (as returned by /reports/complaints/count) is more than 500, specify the optional “startindex” parameter repeatedly, incrementing by 500 each time, until all have been retrieved.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format
    • endtimeRequired. End date/time range in full, ISO 8601 format
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with an empty result.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
      NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
    • startindex — Number indicating where to begin reporting results.

    Example Results (JSON)

    {"response":{"status":200,"message":"OK","data":{"complaints":[{"emailaddress":"recipient@somedomain.net","date":"2013-01-01T16:14:37+00:00","complainttime":"2013-01-01T16:14:37+00:00","notified":false,"notifiedtime":"1970-01-01T00:00:00+00:00","xheaders":{"X-Sample1":"91835","X-Type":"customer"}},{"emailaddress":"recipient@anotherdomain.com","date":"2013-01-04T16:09:54+00:00","complainttime":"2013-01-04T16:09:54+00:00","notified":false,"notifiedtime":"1970-01-01T00:00:00+00:00","xheaders":{"X-Sample1":"91837","X-Type":"customer"}},{"emailaddress":"someoneelse@anotherdomain.com","date":"2013-01-04T16:15:08+00:00","complainttime":"2013-01-04T16:15:08+00:00","notified":false,"notifiedtime":"1970-01-01T00:00:00+00:00","xheaders":{"X-Sample1":"91373","X-Type":"lead"}}]}}}

    GET /reports/complaints/count

    Returns total number of SPAM complaints that the specified account received within a specified date range, optionally filtered by sender. NOTE: When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    NOTE: To greatly improve performance and response time, it is best to use whole dates within the parameters starttime and endtime (i.e., no time specified or “00:00:00” for time).

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format.
    • endtimeRequired. Start date/time range in full, ISO 8601 format.
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with an empty result.

    Example Results (JSON)

    {"response":{"status":200,"message":"OK","data":{"count":"74"}}}

    GET /reports/bounces

    Returns a list of all email bounces received for the specified account for the specified bounce date range, optionally filtered by sender. Including a date range is highly recommended. Method returns a maximum number of 500 email addresses at a time, so when the total sent (as returned by /reports/sent/count) is more than 500, specify the optional “starting index” parameter repeatedly, incrementing by 500 each time, until all have been retrieved.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    DEPRECATED: The noheaders option that determines whether or not headers are included in the response, is no longer available. The full bounce message header for any given bounce email message is available in the email portal Bounce Report. It can be viewed from the email portal Bounce Report by clicking on the Bounce Code field for any email listed in the report.

    previouslyhardbounce and previouslycomplained are no longer reported in the Bounce Report. These emails are not true bounces as they have not been sent because the recipient is suppressed, either due to a previous hard bounce or a complaint. Details on these can now be found in the Blocked Email reports.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format
    • endtimeRequired. End date/time range in full, ISO 8601 format
    • emailaddress — Email address of recipient for filtering.
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with an empty result.
    • startindex — Number indicating where to begin reporting results.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
      NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
    • bouncetype — Type of bounce for filtering. Valid Values: hard or soft.
      • hard – Attempted delivery fatally failed.
      • soft – Attempted delivery failed with transient, temporary, or otherwise non-fatal reason.

    bouncerule – Bounce rules are apart of the bouncetype response. They types of bounce rules are defined below.

    • bad-configuration – A configuration problem at the receiving email provider caused delivery to fail.
    • bad-connection – Indicates a connection could not be successfully made to the receiving server.
    • bad-domain – The recipient domain was not recognized.
    • bad-mailbox – Non-existent recipient.
    • content-related – Indicates email content has been classified as spam by the receiving email provider.
    • inactive-mailbox – The recipient mailbox is currently inactive or has been disabled.
    • invalid-sender – The email sender was recognized as invalid.
    • message-expired – The email has exceeded its expiration date.
    • no-answer-from-host – There was no response by the receiving email provider.
    • other – The email was not successfully delivered for a reason other than the common classifications listed.
    • policy-related – Indicates email has been classified as spam by the receiving email provider.
    • protocol-errors – There were protocol errors in communication with the receiving email provider.
    • quota-issues – Recipient mailbox is full or recipient’s quota has been exceeded.
    • relaying-issues – Error in transmission between Dyn and the email provider.
    • routing-errors – The email was not delivered due to errors in routing to the receiving email provider.
    • spam-related – Email has been classified as spam by the receiving email provider.
    • unclassified – The email has not been able to be classified by Dyn’s system.
    • virus-related – The receiving email provider has detected a virus within the email.

    Example Results (JSON)

    {"response":
        {"status":200,"message":"OK","data":{
            "bounces": [
                        { "emailaddress: "email@domain.org",
                        "bouncetype":"hard",
                        "bouncerule":"bad-mailbox",
                        "bouncecode: "5.3.2",
                        "bouncetime":"2016-02-12T15:19:21+00:00",
                        "notified":true,
                        "notifiedtime":"2016-02-12T22:00:20+00:00",
                        "X-SubscriberID":"486",
                        "X-MailCampaign": "Notification",
                        "xheaders": {
                            "X-SubscriberID": "486",
                            "X-MailCampaign": "Notification"
                            }
                        },…
                      ]
                }
        }
    }

    GET /reports/bounces/count

    Returns the total number of email bounces for the specified account within a specified date range, optionally filtered by sender.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    NOTE: To greatly improve performance and response time, it is best to use whole dates within the parameters starttime and endtime (i.e., no time specified or “00:00:00” for time).

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format.
    • endtimeRequired. End date/time range in full, ISO 8601 format.
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with a count of 0.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
      NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”

    Example Results (JSON)

    {
    "response":{
        "status": 200,
        "message": "OK",
        "data":{
            "count": 10152,
            "totalcount": 10152,
            "hardbouncecount": 3384,
            "softbouncecount": 6768
            }
        }
    }

    GET /reports/delivered

    Returns a list of all emails sent through the specified account that were successfully delivered within a specified date range, optionally filtered by sender. When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    Method returns a maximum number of 500 email addresses at a time. When the total delivered (as returned by /reports/delivered/count) is more than 500, specify the optional “starting index” parameter repeatedly, incrementing by 500 each time, until all have been retrieved.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format
    • endtimeRequired. End date/time range in full, ISO 8601 format
    • startindex – Starting index value (optional).
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with a count of 0.
    • xheaders — Begins the custom X-header section of the response, if any.

    Example Results (JSON)

    NOTE: mssenttime has been replace by senttimestamp in the response data.

    {"response":{
        "status": 200,
        "message": "OK",
        "data":{
        "delivered":[
                    {
                        "userid": 22,
                        "senttime": "2016-11-22T00:00:00+00:00",
                        "senttimestamp": 1479772800,
                        "emailaddress": "recipient2@gmail.com",
                        "xheaders":{
                            "X-CampaignMaster12": "Discount",
                            "X-DistrictMaster12": "Florida"
                        }
                    },
                    ....,
                    ]
        }
    }

    Response Fields

    • status — Identifies the state of the HTML message. Status code #.
    • message — Status Code explanation.
    • data — Begins the data section of the response.
    • userid — Numerical identifier of the authorized sender.
    • senttime — Date and time identifying when the email was processed for sending.
    • emailaddress — Identifies the email address where the message was sent.
    • xheaders — Begins the custom X-header section of the response, if any.

    GET /reports/delivered/count

    Returns total number of emails sent through the specified account that were successfully delivered within a specified date range, optionally filtered by sender. When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.
    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    NOTE: To greatly improve performance and response time, it is best to use whole dates within the parameters starttime and endtime (i.e., no time specified or “00:00:00” for time).

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format.
    • endtimeRequired. Timestamp for the end of the report.
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with a count of 0.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
      NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”

    Example Results (JSON):

    {
    "response":{
        "status": 200,
        "message": "OK",
        "data":{
            "count": 3948
            }
        }
    }

    GET /reports/sent

    Returns a list of all emails sent through the specified account within a specified date range, optionally filtered by sender. When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    Method returns a maximum number of 500 email addresses at a time. When the total sent (as returned by /reports/sent/count) is more than 500, specify the optional “starting index” parameter repeatedly, incrementing by 500 each time, until all have been retrieved.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format
    • endtimeRequired. End date/time range in full, ISO 8601 format
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with an empty result.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
    • startindex — Number indicating where to begin reporting results.

    DEPRECATED: The noheaders option that determines whether or not headers are included in the response, is no longer available. The full bounce message header for any given bounce email message is available in the email portal Bounce Report. It can be viewed from the email portal Bounce Report by clicking on the Bounce Code field for any email listed in the report.



    Example Results (JSON):

    {"response":{
        "status":200,
        "message":"OK",
        "data":{
            "sent":[{
                "userid":"123456",
                "senttime":"2015-05-01T11:59:53+00:00",
                "date":"2015-05-01T11:59:53+00:00",
                "emailaddress":"123456@example.com",
                "email":"123456@example.com",
                "xheaders":{
                    "X-Member-ID":"123456",
                    "X-WLD-Type-ID":"123","X-WLD-Site-ID":"12345",
                    "X-WLD-Message-ID":"123456789ABCDEFGHIJKL.example.com"}
                    }]
                }
            }
    }

    GET /reports/sent/count

    Returns the total number of emails sent through the specified account within a specified date range, optionally filtered by sender.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    NOTE: To greatly improve performance and response time, it is best to use whole dates within the parameters starttime and endtime (i.e., no time specified or “00:00:00” for time).

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format
    • endtimeRequired. End date/time range in full, ISO 8601 format
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with a count of 0.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.
      NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”

    Example Results (JSON)

    {"response":{"status":200,"message":"OK","data":{"count":"74"}}}

    GET /reports/blockedemail

    Returns a list of all emails that were blocked from sending due to a suppressed recipient through the specified account within a specified date range, optionally filtered by sender. When starttime and endtime values are not provided, they default to one month prior and the current date and time. Including a date range is highly recommended.

    Method returns a maximum number of 500 email addresses at a time. When the total blocked emails (as returned by /reports/blockedemail/count) is more than 500, specify the optional startindex parameter.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format
    • endtimeRequired. End date/time range in full, ISO 8601 format
    • emailaddress — Email address of recipient for filtering.
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with an empty result.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
    • startindex — Number indicating where to begin reporting results.

    Example Results (JSON)

    {
    "response":
        {
        "status": 200,
        "message": "OK",
        "data":{
            "blocked-email":[
                    {
                    "userid": 22,
                    "senttime": "2016-11-22T00:00:00+00:00",
                    "date": "2016-11-22T00:00:00+00:00",
                    "emailaddress": "recipient2@gmail.com",
                    "email": "recipient2@gmail.com",
                    "blockedreason": "hardbounce",
                    "xheaders":{
                        "X-CampaignMaster12": "Monthly Special",
                        "X-DistrictMaster12": "Colorado"
                        }
                    }, .....
                    ]
            }
        }
    }
    

    GET /reports/blockedemail/count

    Returns the total number of emails blocked from sending through the specified account due to suppressed recipients within a specified date range, optionally filtered by sender.

    NOTE: Use starttime and endtime for optimal performance. Data returned will be greater than or equal to (>=) starttime and less than (<) endtime.

    NOTE: To greatly improve performance and response time, it is best to use whole dates within the parameters starttime and endtime (i.e., no time specified or “00:00:00” for time).

    Parameters

    • apikeyRequired. API key of the account with the desired information.
    • starttimeRequired. Start date/time range in full, ISO 8601 format
    • endtimeRequired. End date/time range in full, ISO 8601 format
    • sender — Email address of sender for filtering. An invalid sender value will return a 200 OK response with an empty result.
    • [X-HeaderName] — Name of searchable custom X-header. X-header names are in the format X-[name of header]. X-header values are the search parameter to find in the X-header field. Be sure to url-encode the search value.NOTE: When setting X-Header values, it is important to avoid using the greater than (<) and lesser than (>) symbols in your X-Header values. A valid X-Header value looks like this: “some_xheader_value_string_here”
    • Example Results (JSON)

      
      {
      "response":{
          "status": 200,
          "message": "OK",
          "data":{
              "count": 15792
              }
          }
      }