Email API

API change history

Email API contains methods for handling various aspects of email campaigns (design, send) as well as recipients (list of email addresses, additional data to merge into message text), etc.

getCampaignSummary

Provides a basic summary of the results for any sent campaign such as the number of recipients, opens, clicks, unsubscribes, etc to date. Also includes the web version URL, and the public Worldview URL for the campaign.

Try it

Request

Request URL

Request parameters

  • string

    Format - uuid. Campaign ID

Request headers

  • string

    The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

Request body

Responses

200 OK

Returns the current subscriber details.

Representations

{
  "Recipients": 250,
  "TotalOpened": 195,
  "Clicks": 140,
  "Unsubscribed": 22,
  "Bounced": 3,
  "UniqueOpened": 180,
  "SpamComplaints": 13,
  "WebVersionURL": "http://www.touchbasepro.com/c/93e847530294/",
  "WebVersionTextURL": "http://www.touchbasepro.com/ct/93e847530294",
  "WorldviewURL": "http://www.touchbasepro.com/reports/c/93e847530294",
  "Forwards": 2,
  "Likes": 11,
  "Mentions": 5
}
{
  "required": [
    "Recipients",
    "TotalOpened",
    "Clicks",
    "Unsubscribed",
    "UniqueOpened",
    "SpamComplaints",
    "WebVersionURL",
    "WebVersionTextURL",
    "WorldviewURL",
    "Forwards",
    "Likes",
    "Mentions"
  ],
  "type": "object",
  "properties": {
    "Recipients": {
      "type": "integer",
      "description": "Number of campaign recipients",
      "format": "int32",
      "readOnly": true
    },
    "TotalOpened": {
      "type": "integer",
      "description": "Number of times it got opened",
      "format": "int32",
      "readOnly": true
    },
    "Clicks": {
      "type": "integer",
      "description": "Total number of clicks",
      "format": "int32",
      "readOnly": true
    },
    "Unsubscribed": {
      "type": "integer",
      "description": "Number of unsubscribe events",
      "format": "int32",
      "readOnly": true
    },
    "Bounced": {
      "type": "integer",
      "description": "Total number of bounces",
      "format": "int32",
      "readOnly": true
    },
    "UniqueOpened": {
      "type": "integer",
      "description": "Number of times it got opened (by different recipients)",
      "format": "int32",
      "readOnly": true
    },
    "SpamComplaints": {
      "type": "integer",
      "description": "Number of spam complaints",
      "format": "int32",
      "readOnly": true
    },
    "WebVersionURL": {
      "type": "string",
      "description": "Web version url",
      "format": "uri",
      "readOnly": true
    },
    "WebVersionTextURL": {
      "type": "string",
      "description": "Text-only web version url",
      "format": "uri",
      "readOnly": true
    },
    "WorldviewURL": {
      "type": "string",
      "description": "Web version url",
      "format": "uri",
      "readOnly": true
    },
    "Forwards": {
      "type": "integer",
      "description": "Number of times it got forwarded",
      "format": "int32",
      "readOnly": true
    },
    "Likes": {
      "type": "integer",
      "description": "Number of times it got liked",
      "format": "int32",
      "readOnly": true
    },
    "Mentions": {
      "type": "integer",
      "description": "Number of mentions",
      "format": "int32",
      "readOnly": true
    }
  }
}

400 Bad Request

An invalid or incomplete request. Please check all information is formatted correctly and try again.

Representations

{
  "status": 400,
  "message": "An invalid or incomplete request. Please check all information is formatted correctly and try again."
}

401 Unauthorized

The API key is invalid. Please verify it is correct and try again.

Representations

{
  "status": 401,
  "message": "API key is invalid."
}

403 Forbidden

There is not enough credits on your account or your account has been suspended. Please check with your account representative for more information.

Representations

{
  "status": 403,
  "message": "Not enough credits in this account."
}

429 Too many requests

The number of API calls has been exceeded. The return will include the number of seconds (represented by (number of seconds) in the example) until the API call can be tried again.

Representations

{
  "status": 429,
  "message": "Rate limit is exceeded.  Try again in {number of seconds} seconds."
}

500 Internal Server Error

Some error occurred in the processing request. Please try it again at a later time.

Representations

{
  "status": 500,
  "message": "An internal error has occurred. We have been notified about it and will restore service functionality as soon as possible."
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.touchbasepro.com/email/campaigns/{campaignId}/summary"
-H "Authorization: Bearer API_KEY"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "Bearer API_KEY");

            var uri = "https://api.touchbasepro.com/email/campaigns/{campaignId}/summary?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.touchbasepro.com/email/campaigns/{campaignId}/summary");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "Bearer API_KEY");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.touchbasepro.com/email/campaigns/{campaignId}/summary?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","Bearer API_KEY");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.touchbasepro.com/email/campaigns/{campaignId}/summary";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"Bearer API_KEY" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.touchbasepro.com/email/campaigns/{campaignId}/summary');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => 'Bearer API_KEY',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': 'Bearer API_KEY',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.touchbasepro.com')
    conn.request("GET", "/email/campaigns/{campaignId}/summary?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': 'Bearer API_KEY',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.touchbasepro.com')
    conn.request("GET", "/email/campaigns/{campaignId}/summary?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.touchbasepro.com/email/campaigns/{campaignId}/summary')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = 'Bearer API_KEY'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body