« Back to Documentation Overview

campaignGeoOpensForCountry – v1.2

 campaignGeoOpensForCountry(string apikey, string cid, string code)

Retrieve the regions and number of opens tracked for a certain country. 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())
code An ISO3166 2 digit country code
Returns
array regions an array of regions within the provided country where opens occurred.
Returned Fields
stringcodeAn internal code for the region. When this is blank, it indicates we know the country, but not the region
stringnameThe name of the region, if we have one. For blank "code" values, this will be "Rest of Country"
intopensThe total number of opens that occurred in the country