JavaScript Requires Chilkat v11.0.0+
JavaScript
Constant Contact V3: Compare results for sent email activities
See more Constant Contact Examples
Compare one to ten sent primary_email or resend activities with status DONE. Supply activity IDs from your sent newsletters. Campaign IDs identify a different resource. This report requires campaign_data and permission to view campaign metrics.
Each row shows sends, unique opens, unique clicks, bounces and the last metrics refresh. The code matches results by activity ID, keeps the input order, and prints any partial-success errors alongside the available results. A missing result is reported separately from a measured zero.
Authorize the application using the same account and credential store.
Constant Contact developer guide
Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat
v11.4.0 or greater.
var success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
var vault = new CkSecrets();
vault.Location = "local_manager";
vault.AutoSplit = true;
var entry = new CkJsonObject();
entry.UpdateString("appName","ConstantContactV3");
entry.UpdateString("service","OAuth2");
entry.UpdateString("username","my-account");
var tokens = new CkJsonObject();
var loaded = vault.GetSecretJson(entry,tokens);
if (loaded !== true) {
console.log("Run the desktop authorization example using this account and store.");
return;
}
if (tokens.JsonTypeOf("access_token") !== 1) {
console.log("The saved authorization has no access token.");
return;
}
var http = new CkHttp();
http.RequireSslCertVerify = true;
http.AuthToken = tokens.StringOf("access_token");
var resp = new CkHttpResponse();
var ids = new CkJsonArray();
ids.AddStringAt(-1,"FIRST_SENT_ACTIVITY_ID");
ids.AddStringAt(-1,"SECOND_SENT_ACTIVITY_ID");
if ((ids.Size < 1) || (ids.Size > 10)) {
console.log("Choose one to ten sent activity IDs.");
return;
}
var url = new CkStringBuilder();
url.Append("https://api.cc.email/v3/reports/stats/email_campaign_activities/");
var i = 0;
while ((i < ids.Size)) {
if (i > 0) {
url.Append(",");
}
url.Append(ids.StringAt(i));
i = i+1;
}
success = http.HttpNoBody("GET",url.GetAsString(),resp);
if ((success !== true) && (resp.StatusCode <= 0)) {
console.log("Read statistics: HTTP request failed.");
return;
}
if ((success !== true) || ((resp.StatusCode < 200) || (resp.StatusCode >= 300))) {
console.log("Read statistics: HTTP " + resp.StatusCode + " " + resp.BodyStr);
return;
}
var report = new CkJsonObject();
success = report.Load(resp.BodyStr);
if (success !== true) {
console.log("Expected a JSON object in the response.");
return;
}
i = 0;
while ((i < report.SizeOfArray("errors"))) {
report.I = i;
console.log(report.StringOf("errors[i].error_key") + ": " + report.StringOf("errors[i].error_message"));
i = i+1;
}
console.log("Activity ID | Sends | Unique opens | Unique clicks | Bounces | Last refresh");
var row = new CkJsonObject();
i = 0;
while ((i < ids.Size)) {
var id = ids.StringAt(i);
success = report.FindRecord2("results","campaign_activity_id",id,true,row);
if (success == true) {
// StringOf preserves a reported zero and leaves an unavailable individual metric blank.
console.log(id + " | " + row.StringOf("stats.em_sends") + " | " + row.StringOf("stats.em_opens") + " | " + row.StringOf("stats.em_clicks") + " | " + row.StringOf("stats.em_bounces")
+ " | " + row.StringOf("last_refresh_time"));
}
else {
console.log(id + " | No statistics returned");
}
i = i+1;
}