Email API
API change historyEmail 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.
getEmailStatistics
Retrieves delivery and engagement statistics, allowing filtering by smart email or classic group.
Try itRequest
Request URL
Request parameters
-
(optional)string
Email group name
-
(optional)string
Format - date (as full-date in RFC3339). Start date for filtering results
-
(optional)string
Format - date (as full-date in RFC3339). End date for filtering results
-
(optional)string
Time zone name, in case records are filtered by time
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
The email delivery and engagement statistics.
Representations
{
"Query": {
"Group": "string",
"SmartEmailID": "string",
"From": "string",
"To": "string",
"TimeZone": "client’s time zone"
},
"Sent": 0,
"Bounces": 0,
"Delivered": 0,
"Opened": 0,
"Clicked": 0
}
{
"required": [
"Query",
"Sent",
"Bounces",
"Delivered",
"Opened",
"Clicked"
],
"type": "object",
"properties": {
"Query": {
"type": "object",
"properties": {
"Group": {
"type": "string",
"description": "Optional. Filter results by Group by supplying a URL-encoded classic group",
"readOnly": true
},
"SmartEmailID": {
"type": "string",
"description": "Filter results to Smart Email by supplying a smart email ID.",
"format": "uuid",
"readOnly": true
},
"From": {
"type": "string",
"description": "Optional. ISO-8601 date in the format YYYY-MM-DD. Default value is 29 days ago",
"format": "date",
"readOnly": true
},
"To": {
"type": "string",
"description": "Optional. ISO-8601 date in the format YYYY-MM-DD. Default value is current date",
"format": "date",
"readOnly": true
},
"TimeZone": {
"type": "string",
"description": "Optional. Values can be utc or client. When requesting statistics for a specific period of time, you can choose to define that period using either your local time zone or UTC.",
"default": "client’s time zone",
"readOnly": true
}
},
"readOnly": true
},
"Sent": {
"type": "integer",
"description": "Number of sent email messages",
"format": "int32"
},
"Bounces": {
"type": "integer",
"description": "Number of bounced email messages",
"format": "int32"
},
"Delivered": {
"type": "integer",
"description": "Number of delivered email messages",
"format": "int32"
},
"Opened": {
"type": "integer",
"description": "Number of opened email messages",
"format": "int32"
},
"Clicked": {
"type": "integer",
"format": "int32"
}
}
}
400 Bad Request
The request was incorrect. These are the possible errors which may be included in the body of the response:
Code | Description |
---|---|
920 | Invalid from date The date must be provided in the format YYYY-MM-DD |
921 | Invalid from date "From Date" must be before or equal to "To Date" |
922 | Invalid to date The date must be provided in the format YYYY-MM-DD |
923 | Invalid Timezone Timezone must be "utc" or "client" |
924 | Conflict between Group and Smart Email ID You may only supply one of Group or Smart Email ID |
925 | Invalid smartEmailID Value must be a valid GUID. |
993 | You need to set up custom authentication to send transactional emails. Update the settings in your account to manage your own authentication. |
994 | Your sending domain must match your authenticated domain to send transactional email. |
Representations
{
"Code": 920,
"Message": "Invalid From Date"
}
{
"required": [
"Code",
"Message"
],
"type": "object",
"properties": {
"Code": {
"type": "integer",
"description": "Error code",
"format": "int32"
},
"Message": {
"type": "string",
"description": "Error message"
}
}
}
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/transactional/statistics?group={group_name}&from=YYYY-MM-DD&to=YYYY-MM-DD&timezone=America/Anchorage"
-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");
// Request parameters
queryString["group"] = "{group_name}";
queryString["from"] = "YYYY-MM-DD";
queryString["to"] = "YYYY-MM-DD";
queryString["timezone"] = "America/Anchorage";
var uri = "https://api.touchbasepro.com/email/transactional/statistics?" + 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/transactional/statistics");
builder.setParameter("group", "{group_name}");
builder.setParameter("from", "YYYY-MM-DD");
builder.setParameter("to", "YYYY-MM-DD");
builder.setParameter("timezone", "America/Anchorage");
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
"group": "{group_name}",
"from": "YYYY-MM-DD",
"to": "YYYY-MM-DD",
"timezone": "America/Anchorage",
};
$.ajax({
url: "https://api.touchbasepro.com/email/transactional/statistics?" + $.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/transactional/statistics";
NSArray* array = @[
// Request parameters
@"entities=true",
@"group={group_name}",
@"from=YYYY-MM-DD",
@"to=YYYY-MM-DD",
@"timezone=America/Anchorage",
];
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/transactional/statistics');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => 'Bearer API_KEY',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'group' => '{group_name}',
'from' => 'YYYY-MM-DD',
'to' => 'YYYY-MM-DD',
'timezone' => 'America/Anchorage',
);
$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({
# Request parameters
'group': '{group_name}',
'from': 'YYYY-MM-DD',
'to': 'YYYY-MM-DD',
'timezone': 'America/Anchorage',
})
try:
conn = httplib.HTTPSConnection('api.touchbasepro.com')
conn.request("GET", "/email/transactional/statistics?%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({
# Request parameters
'group': '{group_name}',
'from': 'YYYY-MM-DD',
'to': 'YYYY-MM-DD',
'timezone': 'America/Anchorage',
})
try:
conn = http.client.HTTPSConnection('api.touchbasepro.com')
conn.request("GET", "/email/transactional/statistics?%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/transactional/statistics')
query = URI.encode_www_form({
# Request parameters
'group' => '{group_name}',
'from' => 'YYYY-MM-DD',
'to' => 'YYYY-MM-DD',
'timezone' => 'America/Anchorage'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
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