« Back to Documentation Overview

campaignGeoOpens – v1.2

 campaignGeoOpens(string apikey, string cid)

Retrieve the countries and number of opens tracked for each. Email address are not returned.

Section
Campaign Stats
Parameters
apikey a valid API Key for your user account. Get by visiting your API dashboard
cid the campaign id to pull bounces for (can be gathered using campaigns())
Returns
array countries an array of countries where opens occurred
Returned Fields
stringcodeThe ISO3166 2 digit country code
stringnameA version of the country name, if we have it
intopensThe total number of opens that occurred in the country
boolregion_detailWhether or not a subsequent call to campaignGeoOpensByCountry() will return anything