Litmus Help

Still have questions? Email us: hello@litmusapp.com

Data reference

The following explains the different types of data you can request via the API. Most of the attributes are self-explanatory, but there are some Litmus-specific attributes which we've expanded upon in more detail.

Test

<test-set>
  <created-at type="datetime">2008-02-19T14:55:59Z</created-at>
  <id type="integer">11347</id>
  <public-sharing type="boolean">#{true || false}</public-sharing>
  <updated-at type="datetime">2008-02-19T16:26:44Z</updated-at>
  <name>Litmus Insider, February 08 - Preview</name>
  <service>#{email || page}</service>
  <public_path>http://salted.litmusapp.com/pub/c854ae2</public_path>
  <test-set-versions type="array">
    <test-set-version>
    ...
    </test-set-version>
    <test-set-version>
    ...
    </test-set-version>
  </test-set-versions>
</test-set>

public-sharing: Specifies whether the results of this test are displayed at a publicly-accessible URL (the URL is given in public_path).
name: Either the email's subject line, or the web page's title, as appropriate.
public_path: The public URL to view the results of this test (only accessible if public_sharing is set to true).

Version

<test-set-version>
  <version type="integer">1</version>
  <received type="boolean">#{true || false}</received>
  <url_or_guid>c84c48b@emailtests.com</url_or_guid>
  <results type="array">
    <result>
      <error-at type="datetime" nil="true"></error-at>
      <finished-at type="datetime">2008-02-16T20:33:39Z</finished-at>
      <id type="integer">127400</id>
      <started-at type="datetime">2008-02-16T20:33:29Z</started-at>
      <state>#{pending || in_progress || complete || error}</state>
      <testing-application>
        ...
      </testing-application>
      <result-images type="array">
        <result-image>
          ...
        </result-image>
        <result-image>
          ...
        </result-image>
      </result-images>
    </result>
    <result>
      <error-at type="datetime" nil="true"></error-at>
      <finished-at type="datetime">2008-02-16T20:33:39Z</finished-at>
      <id type="integer">127401</id>
      <started-at type="datetime">2008-02-16T20:33:29Z</started-at>
      <state>#{pending || in_progress || complete || error}</state>
      <testing-application>
        ...
      </testing-application>
      <result-images type="array">
        <result-image>
          ...
        </result-image>
        <result-image>
          ...
        </result-image>
      </result-images>
    </result>
  </results>
</test-set-version>

received: Always returns true for web page tests. For email tests, this will show whether Litmus has yet received the email to the email address specified in the url_or_guid field.
url_or_guid: For web page tests, gives the URL of the page being tested. For email tests, gives the unique email address used to receive the email to be tested.
state: Gives the status of an individual result. Initially this will briefly be set to pending. Once a test has begun being processed by our servers this changes to in_progress. Of course, once it's finished the state is complete, and any problems are indicated by error.

Result image

<result-image>
  <id type="integer">339686</id>
  <image_type>#{window || full || full_off || full_on || window_off || window_on }</image_type>
  <full_image>s3.amazonaws.com/sitevista/8a9cc6ce-0be5-4756-9ef5-fp.png</full_image>
  <thumbnail_image>s3.amazonaws.com/sitevista/8a9cc6ce-0be5-4756-fp-thumb.png</thumbnail_image>
</result-image>

image_type: Designates the type of screenshot being referenced. For web page tests, this can be window for a screenshot of the browser window, or full for our FullPage view. For email tests, this can be window_off for the inbox view with images turned off, window_on for the inbox view with images on, full_on for the email opened and images on, and full_off for the emailed opened and images off.
full_image: References a screenshot image, in PNG format. You may prefix this will your choice of "http://" or "https://" depending on your requirements.
thumbnail_image: References a thumbnail image, in PNG format. The dimensions of this will always be 119x84.

Testing application

<testing-application>
  <code>ie7</code>
  <name>Explorer 7.0</name>
  <platform>#{Windows || Mac OS || Linux || Web-based}</platform>
</testing-application>