GetScreenshotResults

Get the screenshot results from an Email Test.

URLs:

Sandbox:

https://sandbox.emailonacid.com/v4/getScreenshotResults - Default (XML) Request
https://sandbox.emailonacid.com/v4/getScreenshotResults/xml - XML Request
https://sandbox.emailonacid.com/v4/getScreenshotResults/json - JSON Request

Production:

https://api.emailonacid.com/v4/getScreenshotResults - Default (XML) Request
https://api.emailonacid.com/v4/getScreenshotResults/xml - XML Request
https://api.emailonacid.com/v4/getScreenshotResults/json - JSON Request

Request:

XML

<?xml version="1.0" encoding="utf-8"?>
<get_screenshot_results>
    <eoa_test_id>UNIQUE EMAIL TEST ID</eoa_test_id>
</get_screenshot_results>

JSON

{
    "eoa_test_id": UNIQUE EMAIL TEST ID
}

JSON Validation Schema:

Click here to download.

Request Details

Element Description Data Type Required
eoa_test_id The reference id for the test to retrieve Integer Y

Response:

XML

<?xml version="1.0" encoding="utf-8"?>
<xml>
    <results>
        <client_results>
            <client_result>
                <client_code>1</client_code>
                <client_name>Outlook 2003</client_name>
                <screen_shot>TRUE</screen_shot>
                <application>Application</application>
                <result>https://sc_api.emailonacid.com/screenshots/sandbox/outlook03/3_197_103727.jpg</result>
                <result_no_images>https://sc_api.emailonacid.com/screenshots/sandbox/outlook03/3_197_103727_no_images.jpg</result_no_images>
                <result_thumbnail></result_thumbnail>
            </client_result>
            <client_result>
                <client_code>2</client_code>
                <client_name>Outlook 2007</client_name>
                <screen_shot>Y</screen_shot>
                <application>Application</application>
                <result>https://sc_api.emailonacid.com/screenshots/sandbox/outlook03/3_197_103727.jpg</result>
                <result_no_images>https://sc_api.emailonacid.com/screenshots/sandbox/outlook03/3_197_103727_no_images.jpg</result_no_images>
                <result_thumbnail></result_thumbnail>
            </client_result>
            ....
        </client_results>
    </results>
</xml>

JSON

{
  "results": {
    "client_results": [
      {
        "client_result": {
          "client_code": "1",
          "client_name": "Outlook 2003",
          "screen_shot": "TRUE",
          "application": "Application",
          "result": "https:\/\/sc_api.emailonacid.com\/screenshots\/sandbox\/outlook03\/3_197_103727.jpg",
          "result_no_images": "https:\/\/sc_api.emailonacid.com\/screenshots\/sandbox\/outlook03\/3_197_103727_no_images.jpg",
          "result_thumbnail": ""
        }
      },
      {
        "client_result": {
          "client_code": "2",
          "client_name": "Outlook 2007",
          "screen_shot": "TRUE",
          "application": "Application",
          "result": "https:\/\/sc_api.emailonacid.com\/screenshots\/sandbox\/outlook07\/3_197_103727.jpg",
          "result_no_images": "https:\/\/sc_api.emailonacid.com\/screenshots\/sandbox\/outlook07\/3_197_103727_no_images.jpg",
          "result_thumbnail": ""
        }
      },
      ....
}

Note: Reference GetStandaloneSpamResults for information on retrieving the spam results.

Response Details

Element Description
client_code The id of the email client.
client_name Name of the email client.
screenshot If the result is an actual screenshot from the client this will be set to TRUE, otherwise it will be FALSE.
application Email client application type. Will be either "web", "desktop" or "mobile".
result Acid Test result with images displayed, if screenshot parameter is set to TRUE this will be a URL to the image. If it's a URL the image may or may not exist yet when the test results are returned. The image will be deleted from our servers after 30 days. It is your responsibility to download it to your server(s) if you would like to keep a test history for your members.
result_imap If ios_fix parameter is set to "B" (Both) this will be a URL to the complete screenshot (only if the iOS fix was needed).
result_no_images Acid Test result with images turned off.
result_no_images_imap If ios_fix parameter is set to "B" (Both) this will be a URL to the complete screenshot with images turned off (only if the iOS fix was needed).
horiz_result Horizontal Acid Test result with images displayed, if screenshot parameter is set to TRUE this will be a URL to the image. This parameter will only exist if we support horizontal screenshots for the client (screenshot_orientation parameter is either H or B in GetClientList). If it's a URL the image may or may not exist yet when the test results are returned. The image will be deleted from our servers after 30 days. It is your responsibility to download it to your server(s) if you would like to keep a test history for your members.
horiz_result_imap If ios_fix parameter is set to "B" (Both) this will be a URL to the complete horizontal screenshot (only if the iOS fix was needed).
horiz_result_no_images Horizontal Acid Test result with images turned off.
horiz_result_no_images_imap If ios_fix parameter is set to "B" (Both) this will be a URL to the complete horizontal screenshot with images turned off (only if the iOS fix was needed).
result_thumbnail If screenshot parameter is set to TRUE this will be a URL to the screenshot thumbnail.
browser_results This element grouping is only supplied when the application value is "web" and screenshot is "TRUE"
os OS the browser was installed.
version Browser version.
browser_name Name of the browser.