The impressions of an emailing can be retrieved with the /emailing/\$emailingID/impressions method. It is possible to filter the returned impressions with the field parameter.

Request url Methods Parameters\$emailingID/impressions GET limit, start, fields[]

Properties of emailing errors

The impressions of an emailing can contain the following information:

  • ID (int, system field, cannot be edited.)
  • timestamp (datetime, system field, cannot be edited.)
  • ip (cannot be edited. The IP address that opened the email.)
  • user-agent (string, cannot be edited. Contains the user-agent with which the mailing was opened.)
  • referer (string, cannot be edited.)
  • destination (int, cannot be edited. The destination of this mailing which opened the mailing.)
  • profile (int, cannot be edited. The ID of the profile.)
  • subprofile (int, cannot be edited. Contains the ID of the subprofile.)

GET Request

Request information about the impressions of an emailing in an account. The request returns a message containing the identifier of the impression, a timestamp, the ip-address, the user-agent, referer, destination, profile ID and the subprofile ID.

Example output

Upon a successful request, you will receive a message similar to the example below.

HTTP/1.1 200 OK
Date: Mon, 11 Aug 2014 12:40:40 GMT 
Server: Apache 
Transfer-Encoding: chunked 
Content-Type: application/json 

        "timestamp":"2014-06-18 14:54:00",
        "user-agent":"Outlook 2013,
         Windows 7",

Searching for emailing impressions with the GET request

By providing the limit or start parameters the results can be controlled. You can also filter the results using the fields[] parameter. An example for retrieving only the impressions that occurred before a particular timestamp: