Resources / Support Articles / API

CreateEmailAnalyticsCode

Description 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 [...]

GetEmailAnalyticsTopClients

Description 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"}]}]

GetEmailAnalyticsTopLocations

Description 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"}]}]

GetEmailAnalyticsCounts

Description 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″}}

GetEmailAnalyticsFeed

Description 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 [...]

GetThumbnail

Description 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"}]

NewThumbnail

Description 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 [...]

RetrieveEmailClients

Description 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"}]

SystemStatus

Description 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"}]

GetAvailableCredits

Description 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}]

GetInboxMonitoringResults

Description 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", [...]

RetryEmailClient

Description 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"}]

DeletePreview

Description 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"}]

CreatePreview

Description 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 [...]

FetchPreview

Description 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 [...]

GetPreviewList

Description 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"}]

Getting Started

For API integration, the only requirement is having basic programming skills. We designed PreviewMyEmail to be an easy-to-integrate service. A programmer with moderate skills can integrate PreviewMyEmail API within appr. 10-15 minutes. PreviewMyEmail API uses the easiest API protocol called HTTP REST. This means that with a basic HTTP connection to our API, you can [...]


Have questions?

Email us! Contact us

Don't hesitate to contact us for your questions. We will be happy to assist you.

Get notified before anyone else!

Subscribe to our email list to receive our newsletter every month