Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
74 lines (55 sloc) 2.39 KB

REST API: GET impressions (Marketing Suite)

Each emailing is tracked, which allows Copernica to provide you with emailing statistics. Impressions are one of these statistics. You can retrieve all impressions for an account by sending an HTTP GET call to the following URL:

https://api.copernica.com/v2/ms/impressions?access_token=xxxx

Parameters

The parameters for this method can be set to retrieve the statistics from a certain period. The following optional parameters are available:

  • begintime: The timestamp after which the impressions must have occurred (YYYY-MM-DD HH:MM:SS format).
  • endtime: The timestamp before which the impressions must have occurred (YYYY-MM-DD HH:MM:SS format).

Returned fields

The method returns a JSON object with several impressions. For each impression the following information is available:

  • ID: The ID of the impression.
  • mailing: The ID of the mailing.
  • timestamp: The timestamp of the impression.
  • ip: The IP where the impression occurred from.
  • useragent: User agent string of the machine the impression occurred from.
  • device: The type of device the impression came from ('desktop','tablet','mobile','unknown').
  • destination: The ID of the destination that caused an impression.
  • profile: The ID of the profile that caused an impression.
  • subprofile: The ID of the subprofile that caused an impression.

JSON example

A single impression might look something like this:

{  
   "ID":"1",
   "mailing":"412",
   "timestamp":"2014-10-09 13:41:46",
   "ip":"2a03:e280:0:1::1",
   "useragent":"Mozilla\/5.0 (Ubuntu; X11; Linux x86_64; rv:8.0) Gecko\/20100101 Firefox\/8.0",
   "device":"desktop",
   "destination":"112",
   "profile":13453,
   "subprofile":null
}

PHP example

This script demonstrates how to use this API method:

// dependencies
require_once('copernica_rest_api.php');

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 2);

// execute the call
print_r($api->get("ms/impressions"));

This example requires the REST API class.

More information

You can’t perform that action at this time.