analyticsOpens - getting a list of subscribers who opened the campaign

analyticsOpens (string apikey, int campaign_id, int start, int count, string filterEmails)

Method output from campaign analysts a list of subscribers who opened the message of campaign.

Parameters
apikey API key to access to your account
campaign_id Nubmer of campaign
start Number of the first subscriber (default = 1, the optional — can be empty)
count Number of the returned records of subscribers (optional, default = 10000, not more than 10,000 per request, optional — can be empty)
filterEmails Output filter for particular subscribers. Email subscribers need to be separated by comma. To display data for all subscribers you should leave parameter empty.
By default, the result is returned in XML, to get the JSON you need to add an additional parameter &output = json

Request form: http://api.feedgee.com/1.0/analyticsOpens?apikey=APIKEY&campaign_Id=CAMPAIGN_ID&start=START&count=COUNT&filterEmails=email1@domain.com, email2@domain.com

The return valuse
success The number of successful requests
errors Number of errors
error Text description of error
code Error code
warning Additional warnings for the xml, not output when null
total Total number of opens
data Array with the data of subscribers who opened campaign
AnalyticsOpens Array with email-addresses of subscribers and the numbers of opens of this subscriber
email Email of subscriber
opens The number of opens

Example (XML)

<ResultOfAnalyticsOpens>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<AnalyticsOpens>
<email>string</email>
<opens>int</opens>
</AnalyticsOpens>
<AnalyticsOpens>
<email>string</email>
<opens>int</opens>
</AnalyticsOpens>
</data>
</ResultOfAnalyticsOpens>

Example (JSON)

{
"success":1,
"errors":0,
"error":"",
"code":0,
"warning":"",
"data":
[{"email":"string",
"opens":int,
"timestamp":null},
{"email":"string",
"opens":1,
"timestamp":null}]
}

Request in PHP

<?
//Your key to access the API
$api_key="";
//Method name
$method="analyticsOpens";
echo"Method:".$method."<br>";
//parameters
$campaign_id="";
$start="1";
$filterEmails="..."
$parameters="apikey=$api_key&campaign_id=$campaign_id&start=$start&count=$count&filterEmails=$filterEmails";
echo"Parameters:".$parameters."<br>";
//Create a GET-request
$api_url="http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo"Url:".$api_url."<br><hr/>";
//Make a request to the API-server
$result=file_get_contents($api_url);
if($result){
//Decoding of answer API-server
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Error in the received reply
echo"InvalidJSON";
}
else{
//Error of get the list of subscribers
if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";}
//Display the names and values
echo"Here'salistofyourdata:<br>";
foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons
foreach($jsonsas$key=>$custom){
if(is_array($custom)){
echo$key.":<br/>";
foreach($customas$one){
echo"&nbsp;&nbsp;&nbsp;&nbsp;->".$one->name.":".$one->value."<br/>";
}
}else{
echo$key.":".$custom."<br/>";
}
}
}
}
}else{
//Error connecting to API-server
echo"APIaccesserror";
}
?>

SOAP request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:analyticsOpens>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:start>int</tem:start>
<tem:count>int</tem:count>
<tem:filterEmails>string</tem:count>
</tem:analyticsOpens>
</soapenv:Body>
</soapenv:Envelope>

analyticsClicks - getting a list of subscribers who clicked on the links

analyticsClicks (string apikey, int campaign_id, int start, int count, string filterEmails)

Method output from campaign analysts a list of subscribers who clicked on the links in the message of campaign.

Parameters
apikey API key to access to your account
campaign_id Nubmer of campaign
start Number of the first subscriber (default = 1, the optional — can be empty)
count Number of the returned records of subscribers (optional, default = 10000, not more than 10,000 per request, optional — can be empty)
filterEmails Output filter for particular subscribers. Email subscribers need to be separated by comma. To display data for all subscribers you should leave parameter empty.
By default, the result is returned in XML, to get the JSON you need to add an additional parameter &output = json

Request form: http://api.feedgee.com/1.0/analyticsClicks?apikey=APIKEY&campaign_Id=CAMPAIGN_ID&start=START&count=COUNT&filterEmails=email1@domain.com, email2@domain.com

The return value
success The number of successful requests
errors Number of errors
error Text description of error
code Error code
warning Additional warnings for the xml, not output when null
total Total number of clicks
data Array with the data of subscribers who clicked on the links
AnalyticsClicks Array with the data of clicks of the one subscriber
email Email of subscriber
clicks The number of clicks
link Link
timestamp The transition time

Example (XML)

<ResultOfAnalyticsClicks>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<AnalyticsClicks>
<email>string</email>
<clicks>int</clicks>
<link>string</link>
<timestamp>string</timestamp>
</AnalyticsClicks>
</data>
</ResultOfAnalyticsClicks>

Example (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":""
"data":
[{"email":"string",
"link":"string",
"clicks":int,
"timestamp":"string"}],
}]
}

Request in PHP

<?
//Your key to access the API
$api_key="";
//Method name
$method="analyticsClicks";
echo"Method:".$method."<br>";
//parameters
$campaign_id="";
$start="1";
$count="10";
$filterEmails="email@domain.com"
$parameters="apikey=$api_key&campaign_id=$campaign_id&start=$start&count=$count&filterEmails=$filterEmails";
echo"Parameters:".$parameters."<br>";
//Create a GET-request
$api_url="http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo"Url:".$api_url."<br><hr/>";
//Make a request to the API-server
$result=file_get_contents($api_url);
if($result){
//Decoding of answer API-server
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Error in the received reply
echo"InvalidJSON";
}
else{
//Error of get the list of subscribers
if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";}
//Display the names and values
echo"Here'salistofyourdata:<br>";
foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons
foreach($jsonsas$key=>$custom){
if(is_array($custom)){
echo$key.":<br/>";
foreach($customas$one){
echo"&nbsp;&nbsp;&nbsp;&nbsp;->".$one->name.":".$one->value."<br/>";
}
}else{
echo$key.":".$custom."<br/>";
}
}
}
}
}else{
//Error connecting to API-server
echo"APIaccesserror";
}
?>

SOAP request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:analyticsClicks>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:start>string</tem:start>
<tem:count>string</tem:count>
<tem:filterEmails>string</tem:filterEmails>
</tem:analyticsClicks>
</soapenv:Body>
</soapenv:Envelope>

analyticsLinksActivity - getting indicators of links activity

analyticsLinksActivity (string apikey, int campaign_id, string filterEmails)

Method get from campaign analysts list of links in the message and indicators of their effectiveness.

Parameters
apikey API key to access to your account
campaign_id Nubmer of campaign
filterEmails (option will be added soon) Output filter for particular subscribers. Email subscribers need to be separated by comma. To display data for all subscribers you should leave parameter empty.
By default, the result is returned in XML, to get the JSON you need to add an additional parameter &output = json

Request form: http://api.feedgee.com/1.0/analyticsLinksActivity?apikey=APIKEY&campaign_Id=CAMPAIGN_ID&filterEmails=email1@domain.com, email2@domain.com

The return value
success The number of successful requests
errors Number of errors
error Text description of error
code Error code
warning Additional warnings for the xml, not output when null
data Array with a list of links
AnalyticsLinksActivity Array with a activity of the links
link Link
clicks The number of clicks
unique_clicks The number of unique clicks
ctr Click-through rate (CTR)
ctor Click through open rate (CTOR)

Example (XML)

<ResultOfAnalyticsLinksActivity>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<AnalyticsLinksActivity>
<link>string</link>
<clicks>int</clicks>
<unique_clicks>int</unique_clicks>
<ctr>double</ctr>
<ctor>double</ctor>
</AnalyticsLinksActivity>
<AnalyticsLinksActivity>
<link>string</link>
<clicks>int</clicks>
<unique_clicks>int</unique_clicks>
<ctr>double</ctr>
<ctor>double</ctor>
</AnalyticsLinksActivity>
</data>
</ResultOfAnalyticsLinksActivity>

Example (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":""
"data":
[{"link":"string”,
"clicks":"int",
"unique_clicks":"int"
"ctr":"double",
"ctor":"double"}]
}

Request in PHP

<?
//Your key to access the API
$api_key="";
//Method name
$method="analyticsLinksActivity";
echo"Method:".$method."<br>";
//parameters
$campaign_id="";
$filterEmails="email@domain.com"
$parameters="apikey=$api_key&campaign_id=$campaign_id&filterEmails=$filterEmails";
echo"Parameters:".$parameters."<br>";
//Create a GET-request
$api_url="http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo"Url:".$api_url."<br><hr/>";
//Make a request to the API-server
$result=file_get_contents($api_url);
if($result){
//Decoding of answer API-server
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Error in the received reply
echo"InvalidJSON";
}
else{
//Error of get the list of subscribers
if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";}
//Display the names and values
echo"Here'salistofyourdata:<br>";
foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons
foreach($jsonsas$key=>$custom){
if(is_array($custom)){
echo$key.":<br/>";
foreach($customas$one){
echo"&nbsp;&nbsp;&nbsp;&nbsp;->".$one->name.":".$one->value."<br/>";
}
}else{
echo$key.":".$custom."<br/>";
}
}
}
}
}else{
//Error connecting to API-server
echo"APIaccesserror";
}
?>

SOAP request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:analyticsLinksActivity>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:filterEmails>string</tem:filterEmails>
</tem:analyticsLinksActivity>
</soapenv:Body>
</soapenv:Envelope>

analyticsUndelivered - getting a list of subscribers who haven't received the campaign

analyticsUndelivered (string apikey, int campaign_id, int start, int count, string filterEmails)

Method output from campaign analysts a list of subscribers who haven't received the message of campaign for different reasons and the reasons of not delivery.

Parameters
apikey API key to access to your account
campaign_id Nubmer of campaign
start Number of the first subscriber (default = 1, the optional — can be empty)
count Number of the returned records of subscribers (optional, default = 10000, not more than 10,000 per request, optional — can be empty)
filterEmails Output filter for particular subscribers. Email subscribers need to be separated by comma. To display data for all subscribers you should leave parameter empty.
By default, the result is returned in XML, to get the JSON you need to add an additional parameter &output = json

Request form: http://api.feedgee.com/1.0/analyticsUndelivered?apikey=APIKEY&campaign_Id=CAMPAIGN_ID&start=START&count=COUNT&filterEmails=email1@domain.com, email2@domain.com

The return value
success The number of successful requests
errors Number of errors
error Text description of error
code Error code
warning Additional warnings for the xml, not output when null
total Total number of bounces
data Array with data of subscribers who haven't received the campaign
AnalyticsUndelivered Array with data of one subscriber and the reason of not delivery
email Email of subscriber
reason The reason of not delivery
timestamp The registration time of information of not delivery

Example (XML)

<ResultOfAnalyticsUndelivered>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<AnalyticsUndelivered>
<email>string</email>
<reason>string</reason>
<timestamp>string</timestamp>
</AnalyticsUndelivered>
<AnalyticsUndelivered>
<email>string</email>
</AnalyticsUndelivered>
</data>
</ResultOfAnalyticsUndelivered>

Example (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":""
"data":
[{"email":"string",
"reason":"string",
"timestamp":"string"}],
}]
}

Request in PHP

<?
//Your key to access the API
$api_key="";
//Method name
$method="analyticsUndelivered";
echo"Method:".$method."<br>";
//parameters
$campaign_id="";
$start="1";
$count="10";
$filterEmails="email@domain.com"
$parameters="apikey=$api_key&campaign_id=$campaign_id&start=$start&count=$count&filterEmails=$filterEmails";
echo"Parameters:".$parameters."<br>";
//Create a GET-request
$api_url="http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo"Url:".$api_url."<br><hr/>";
//Make a request to the API-server
$result=file_get_contents($api_url);
if($result){
//Decoding of answer API-server
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Error in the received reply
echo"InvalidJSON";
}
else{
//Error of get the list of subscribers
if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";}
//Display the names and values
echo"Here'salistofyourdata:<br>";
foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons
foreach($jsonsas$key=>$custom){
if(is_array($custom)){
echo$key.":<br/>";
foreach($customas$one){
echo"&nbsp;&nbsp;&nbsp;&nbsp;->".$one->name.":".$one->value."<br/>";
}
}else{
echo$key.":".$custom."<br/>";
}
}
}
}
}else{
//Error connecting to API-server
echo"APIaccesserror";
}
?>

SOAP request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:analyticsUndelivered>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:start>string</tem:start>
<tem:count>string</tem:count>
<tem:filterEmails>string</tem:filterEmails>
</tem:analyticsUndelivered>
</soapenv:Body>
</soapenv:Envelope>

analyticsUnsubscribed - getting a list of subscribers who unsubscribe

analyticsUnsubscribed (string apikey, int campaign_id, int start, int count, string filterEmails)

Method output from campaign analysts a list of subscribers who unsubscribe.

Parameters
apikey API key to access to your account
campaign_id Nubmer of campaign
start Number of the first subscriber (default = 1, the optional — can be empty)
count Number of the returned records of subscribers (optional, default = 10000, not more than 10,000 per request, optional — can be empty)
filterEmails Output filter for particular subscribers. Email subscribers need to be separated by comma. To display data for all subscribers you should leave parameter empty.
By default, the result is returned in XML, to get the JSON you need to add an additional parameter &output = json

Request form: http://api.feedgee.com/1.0/analyticsUnsubscribed?apikey=APIKEY&campaign_Id=CAMPAIGN_ID&start=START&count=COUNT&filterEmails=email1@domain.com, email2@domain.com

The return value
success The number of successful requests
errors Number of errors
error Text description of error
code Error code
warning Additional warnings for the xml, not output when null
total Total number of unsubscribed
data Array with data of subscribers who unsubscribe
AnalyticsUnsubscribed Array with the data of one subscriber
email Email of subscriber
timestamp Time of unsubscribe

Example (XML)

<ResultOfAnalyticsUnsubscribed>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<AnalyticsUnsubscribed>
<email>string</email>
<timestamp>string</timestamp>
</AnalyticsUnsubscribed>
<AnalyticsUnsubscribed>
<email>string</email>
<timestamp>string</timestamp>
</AnalyticsUnsubscribed>
</data>
</ResultOfAnalyticsUnsubscribed>

Example (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":""
"data":
[{"email":"string",
"timestamp":"string"}],
}]
}

Request in PHP

<?
//Your key to access the API
$api_key="";
//Method name
$method="analyticsUnsubscribed";
echo"Method:".$method."<br>";
//parameters
$campaign_id="";
$start="1";
$count="10";
$filterEmails="email@domain.com"
$parameters="apikey=$api_key&campaign_id=$campaign_id&start=$start&count=$count&filterEmails=$filterEmails";
echo"Parameters:".$parameters."<br>";
//Create a GET-request
$api_url="http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo"Url:".$api_url."<br><hr/>";
//Make a request to the API-server
$result=file_get_contents($api_url);
if($result){
//Decoding of answer API-server
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Error in the received reply
echo"InvalidJSON";
}
else{
//Error of get the list of subscribers
if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";}
//Display the names and values
echo"Here'salistofyourdata:<br>";
foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons
foreach($jsonsas$key=>$custom){
if(is_array($custom)){
echo$key.":<br/>";
foreach($customas$one){
echo"&nbsp;&nbsp;&nbsp;&nbsp;->".$one->name.":".$one->value."<br/>";
}
}else{
echo$key.":".$custom."<br/>";
}
}
}
}
}else{
//Error connecting to API-server
echo"APIaccesserror";
}
?>

SOAP request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:analyticsUnsubscribed>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:start>string</tem:start>
<tem:count>string</tem:count>
<tem:filterEmails>string</tem:filterEmails>
</tem:analyticsUnsubscribed>
</soapenv:Body>
</soapenv:Envelope>

analyticsEmailGetResults - getting the basic indicators of analytics

analyticsEmailGetResults (string apikey, int campaign_id)

Method output the basic indicators of analytics.

Parameters
apikey API key to access to your account
campaign_id Nubmer of campaign
By default, the result is returned in XML, to get the JSON you need to add an additional parameter &output = json

Request form: http://api.feedgee.com/1.0/analyticsEmailGetResults?apikey=APIKEY&campaign_Id=CAMPAIGN_ID

The return value
success The number of successful requests
errors Number of errors
error Text description of error
code Error code
warning Additional warnings for the xml, not output when null
data Array with data of analytics
AnalyticsEmailGetResults Array with the basic indicators of campaign
campaign_name Name of campaign
campaign_subject Subject
sent The number of subscribers to whom campaign was sent
opens The number of subscribers who opened the campaign
clicks The number of subscribers who clicked on the links
undelivered The number of subscribers who haven't received campaign
unsubscribed The number of subscribers who unsubscribed from campaign
spam The number of subscribers, who marked campaign as spam
ctcr Click through content rate (CTCR)

Example (XML)

<ResultOfAnalyticsEmailGetResults>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<AnalyticsEmailGetResults>
<campaign_name>string</campaign_name>
<campaign_subject>string</campaign_subject>
<campaign_sentdate>string</campaign_sentdate>
<sent>int</sent>
<opens>int</opens>
<clicks>int</clicks>
<undelivered>int</undelivered>
<unsubscribed>int</unsubscribed>
<spam>int</spam>
<ctcr>double</ctcr>
</AnalyticsEmailGetResults>
</data>
</ResultOfAnalyticsEmailGetResults>

Example (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":""
"data":
[{"campaign_name":"string",
"campaign_subject":"string",
"campaign_sentdate":"string",
"sent":"1",
"opens":"1",
"clicks":"1",
"undelivered":"1",
"unsubscribed":"1",
"spam":"0",
"ctcr":"0.4"}]
}

Request in PHP

<?
//Your key to access the API
$api_key="";
//Method name
$method="analyticsEmailGetResults";
echo"Method:".$method."<br>";
//parameters
$campaign_id="";
$parameters="apikey=$api_key&campaign_id=$campaign_id";
echo"Parameters:".$parameters."<br>";
//Create a GET-request
$api_url="http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo"Url:".$api_url."<br><hr/>";
//Make a request to the API-server
$result=file_get_contents($api_url);
if($result){
//Decoding of answer API-server
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Error in the received reply
echo"InvalidJSON";
}
else{
//Error of get the list of subscribers
if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";}
//Display the names and values
echo"Here'salistofyourdata:<br>";
foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons
foreach($jsonsas$key=>$custom){
if(is_array($custom)){
echo$key.":<br/>";
foreach($customas$one){
echo"&nbsp;&nbsp;&nbsp;&nbsp;->".$one->name.":".$one->value."<br/>";
}
}else{
echo$key.":".$custom."<br/>";
}
}
}
}
}else{
//Error connecting to API-server
echo"APIaccesserror";
}
?>

SOAP request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:analyticsEmailGetResults>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
</tem:analyticsEmailGetResults>
</soapenv:Body>
</soapenv:Envelope>