This API command returns special tracking code to be inserted into outgoing emails. This is required to track analytics and metrics of your email campaigns.

API URL

http://previewmyemail.com/api/CreateEmailAnalyticsCode

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• tag
  Provide the name of the tracking code tag to create the tracking code

Response

API call will return a tracking code in text format.

This API command returns popular email applications/clients detected in your tag.

API URL

http://previewmyemail.com/api/GetEmailAnalyticsTopClients

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• tag
  Provide the name of the tracking code tag to get results for

Response Example

[{"clients":[{"Client":"","Count":"224"},{"Client":"Yahoo! Mail|Yahoo","Count":"34"},{"Client":"Opera|Opera","Count":"1"}]}]

This API command returns top geo-locations detected in your tag.

API URL

http://previewmyemail.com/api/GetEmailAnalyticsTopLocations

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• tag
  Provide the name of the tracking code tag to get results for

Response Example

[{"locations":[{"Location":"London/United Kingdom","Count":"31"},{"Location":"New Delhi\/India","Count":"14"}]}]

This API command returns total numbers such as opens, unique opens, forwards, prints, etc.

API URL

http://previewmyemail.com/api/GetEmailAnalyticsCounts

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• tag
  Provide the name of the tracking code tag to get results for

Response Example

{"counts":{"Opens":"241","UniqueOpens":6,"Forwards":"9","Prints":"9","AvgDuration":659,"TotalDuration":"158731"}}

This API command will return the list of email open, print and forward activities in real-time.

API URL

http://previewmyemail.com/api/GetEmailAnalyticsFeed

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• tag
  Provide the name of the tracking code tag to get results for
• get [after | before]
  what to retrieve. Feed data “after” or “before” the timestamp
• timestamp (optional)
  If you wish to retrieve the feed after a certain date/time, pass this info. It should be in unix timestamp format
• limit (optional)
  If you wish to retrieve limited records, pass the number of records you wish to get back

Response Example

[{
"titles":["ID","Event","Email","Timestamp","Date","Duration","City","Country","Client","Latitude","Longitude"],
"events":[
["1e2f97dae07df43adf80dc9d9633b0a0","Open","test1@test.com",1307433779,"2011-06-07 11:02:59","16","","","","0","0"],
["357f3915a975014430f0f4cbf4148736","Forward","test2@test.com",1307433772,"2011-06-07 11:02:52","0","","","","0","0"],
["b9e3cc3189ce8270fd1f123c06c49d4d","Open","test3@test.com",1307374779,"2011-06-06 18:39:39","0","undefined","undefined","","0","0"],
["a915467b36a7bed75a8ac141e86cee95","Open","test4@test.com",1307374778,"2011-06-06 18:39:38","0","undefined","undefined","","0","0"]
]
}]

Once you create spam filter test request, PreviewMyEmail will test your email on major spam filters and email services such as Norton, Postini, SpamAssassin, Gmail and Yahoo and provide you success/failure rates.

To use this feature, you will need to create a design test request inside your PreviewMyEmail account. You will provide the subject and the HTML code of your email.

As the final step, you will select email applications you want to run test on. You can select all available email applications or only specific ones. Once you submit the test, PreviewMyEmail will open your email on all target email applications, take real screen shots and show them on your screen within a minute.

While your email looks great on Gmail and Apple Mail, it may be totally crapped on Hotmail. Testing your email on each popular email client manually means time and money loss. At this point, PreviewMyEmail comes into the play and becomes your best friend. It takes real screen shots of your email on 30+ popular email applications, tests against spam filters and provide you results within a minute.

Addition to these fantastic features, white-label completely re-brandable API allows you to build your own services and resell to your customers.

This public API command will return the URL of the generated thumbnail. If it’s not ready yet, it will return an error.

API URL

http://previewmyemail.com/api/GetThumbnail

Request Parameters

• RequestID
  The request ID gathered from NewThumbnail API call

Response Example

[{"result":"true", "thumbnail_url":"http:\/\/media.previewmyemail.com\/thumbnails\/203203920929023.jpg"}]

This public API command will get your email content and take a small thumbnail screen shot of it. Useful for displaying a small thumbnail next your email campaigns.

This API command will return a request ID. You can query this request ID with “GetThumbnail” API command in a few minutes to retrieve the URL of your email screen shot thumbnail.

API URL

http://previewmyemail.com/api/NewThumbnail

Request Parameters

• ContentType
  Email content type. It can be ‘HTML’ or ‘Text’
• Content
  Email content

Response Example

[{"result":"true", "requestid":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}]

Returns the list of email clients available for email design testing

API URL

http://previewmyemail.com/api/RetrieveEmailClients

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.

Response Example

[{"client_id":"2", "client_code":"Yahoo", "client_name":"Yahoo! Mail (Classic)"},{"client_id":"3", "client_code":"Hotmail", "client_name":"Hotmail"}]

Returns the current status of email design test servers.

API URL

http://previewmyemail.com/api/SystemStatus

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.

Response Example

[{"client_id":"2", "client_code":"Yahoo", "client_name":"Yahoo! Mail (Classic)", "status":"Online"},{"client_id":"3", "client_code":"Hotmail", "client_name":"Hotmail", "status":"Online"}]

If your account is in pay-as-you-go mode, this command call will return the remaining credits in your account.

API URL

http://previewmyemail.com/api/GetAvailableCredits

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.

Response Example

[{"available_credits":492}]

Returns the list of inbox monitor tests you have made so far.

API URL

http://previewmyemail.com/api/GetInboxMonitoringResults

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.

Response Example

[{"QueueID":"96", "RelUserID":"xx", "FromEmail":"test@test.com", "EmailSubject":"Test Subject", "JobSubmitDate":"2010-08-12 04:37:59", "Result_HotmailCom":"N\/A", "DetectionTime_HotmailCom":"0000-00-00 00:00:00", "Result_YahooCom":"Spam", "DetectionTime_YahooCom":"2010-08-12 04:38:22", "Result_AOLCom":"Spam", "DetectionTime_AOLCom":"2010-08-12 04:38:18", "Result_GmailCom":"Spam", "DetectionTime_GmailCom":"2010-08-12 14:50:41", "Result_MeCom":"Inbox", "DetectionTime_MeCom":"2010-08-12 04:54:58", "Result_MailCom":"Spam", "DetectionTime_MailCom":"2010-08-12 04:38:59"},{"QueueID":"95", "RelUserID":"xx", "FromEmail":"test2@test.com", "EmailSubject":"Test subject", "JobSubmitDate":"2010-07-25 03:14:57", "Result_HotmailCom":"N\/A", "DetectionTime_HotmailCom":"0000-00-00 00:00:00", "Result_YahooCom":"Spam", "DetectionTime_YahooCom":"2010-07-25 03:15:17", "Result_AOLCom":"Inbox", "DetectionTime_AOLCom":"2010-07-25 03:16:15", "Result_GmailCom":"Spam", "DetectionTime_GmailCom":"2010-07-25 03:15:17", "Result_MeCom":"Spam", "DetectionTime_MeCom":"2010-07-25 03:15:06", "Result_MailCom":"Inbox", "DetectionTime_MailCom":"2010-07-25 03:17:32"}]

Runs the email design test again for the target email application

API URL

http://previewmyemail.com/api/RetryEmailClient

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• jobid
  Target ID of the email design test request
• clientcode
  Enter the client code of the target email application

Response Example

[{"result":"true"}]

Deletes the target email design test

API URL

http://previewmyemail.com/api/DeletePreview

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• jobid
  Target ID of the email design test request

Response Example

[{"result":"true"}]

Creates a new email design test request

API URL

http://previewmyemail.com/api/CreatePreview

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• emailbody
  Provide the HTML part of your email (it should be base64 encoded!)
• emailsubject
  Provide the subject of your email (it should be base64 encoded!).
• targetemailapps
  Provide the list of email clients you wish to get screen shots from. This parameter should be passed in array format. Ex: TargetEmailApps[]=3&TargetEmailApps[]=4

Response Example

[{"result":"true", "jobid":"1004075748"}]

Returns the requested email design test results.

API URL

http://previewmyemail.com/api/FetchPreview

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.
• jobid
  This is the ID of the email design test request. It can be retrieved from GetPreviewList API call or after creating your email design test request via CreatePreview API call.

Response Example

[{"subject":"TEST 1","job_id":"123456789","submit_date":"2011-02-12 09:17:34","job_status":"Completed","public_share":"Disabled", "public_share_link":"#","preview_results":[{"client_code":"Yahoo", "image_url_imageson":"screenshot_url_here", "image_url_thumbnail":"screenshot_url_here"}, {"client_code":"Hotmail","image_url_imageson":"screenshot_url_here", "image_url_thumbnail":"screenshot_url_here"}]}]

Returns the list of email design test requests you have done so far.

API URL

http://previewmyemail.com/api/GetPreviewList

Request Parameters

• apikey
  Provide the API key. This key can be found in your account settings page.

Response Example

[{"subject":"TEST 1","job_id":"123456789","submit_date":"2011-02-10 09:17:34","job_status":"Completed","public_share":"Disabled", "public_share_link":"#"}, {"subject":"Test subject 2","job_id":"012345678","submit_date":"2010-12-06 14:26:20", "job_status":"Completed","public_share":"Enabled", "public_share_link":"http:\/\/previewmyemail.com\/public\/20392039"}]

PreviewMyEmail API uses the easiest API protocol called HTTP REST. This means that with a basic HTTP connection to our API, you can delivery your emails.

API Connection URL

You will need to use the following URL to pass parameters to PreviewMyEmail API:

http://previewmyemail.com/api/

API Error Codes

• 2000
  Provided API key is invalid.
• 2001
  The requested API command is only available for monthly unlimited plan users.
• 2002
  Preview request not found
• 2003
  Preview couldn’t be deleted
• 2004
  Preview results couldn’t be deleted
• 2005
  Not enough tredits to perform your request
• 2006
  Email client not found
• 3000
  Missing or incorrect email content type. It should be ‘HTML’ or ‘Text’
• 3001
  Missing email content
• 3002
  Missing request ID
• 3003
  Thumbnail request not found. Incorrect request ID
• 3004
  Thumbnail is not available yet. Please check again later
• 3005
  Rate limit exceeded. We have limits per hour. Please try again next hour.

Example Success API Response

The following response is an example to show you what kind of data will be returned back upon a successful API call:

[{"available_credits":"Unlimited"}]

Example Error API Response

The following response is an example to show you what kind of data will be returned back once an error occurs:

[{"Success":"false","ErrorCode":2000,"ErrorReason":"Invalid APIKey"}]