Litmus Help

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

Versions

Each time a page or email is re-tested, a new version is created. This helps keep track of multiple revisions of a design template.

For more detailed information about the data types returned, take a look at the data reference.

Show

GET /tests/#{test-id}/versions/#{version}.xml

Returns details of a single test version.

Response:

Status: 200 OK
<test-set-version> <version type="integer">2</version> <url_or_guid>http://google.com</url_or_guid> <received>true</received> <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>complete</state> <testing-application> <code>ie7</code> <name>Explorer 7.0</name> <platform>Windows</platform> </testing-application> <result-images type="array"> <result-image> <id type="integer">334242</id> <image_type>full</image_type> <full_image>s3.amazonaws.com/sitevista/127400_IE7-fp.png</full_image> <thumbnail_image>s3.amazonaws.com/sitevista/127400_IE7-fp-thumb.png</thumbnail_image> </result-image> ... </result-images> </result> ... </results> </test-set-version>

List all

GET /tests/#{test-id}/versions.xml

Returns details of all versions of a test.

Response:

Status: 200 OK
<test-set-versions type="array"> <test-set-version> <version type="integer">1</version> <url_or_guid>http://google.com</url_or_guid> <received>true</received> <results type="array"> <result> <error-at type="datetime" nil="true"></error-at> <finished-at type="datetime">2008-02-16T20:42:25Z</finished-at> <id type="integer">127404</id> <started-at type="datetime">2008-02-16T20:42:13Z</started-at> <state>complete</state> <testing-application> <code>ie7</code> <name>Explorer 7.0</name> <platform>Windows</platform> </testing-application> <result-images type="array"> <result-image> <id type="integer">334250</id> <image_type>full</image_type> <full_image>s3.amazonaws.com/sitevista/127404_IE7-fp.png</full_image> <thumbnail_image>s3.amazonaws.com/sitevista/127404_IE7-fp-thumb.png</thumbnail_image> </result-image> ... </result-images> </result> ... </results> </test-set-version> ... </test-set-versions>

Create

POST /tests/#{test-id}/versions.xml

Creates a new version of a test.

Creating a new version of a web page test will re-test the same URL immediately. Creating a new version of an email test will return a new email address in the url_or_guid field and the received field will be false. You'll need to send an email to that address for received to become true and your screenshots to be generated.

Response:

Status: 201 Created
Location: http://companyx.litmusapp.com/tests/11450/versions/2.xml
<test_set_version> <version type="integer">2</version> <url_or_guid>http://google.com</url_or_guid> <received>true</received> <results type="array"> <result> <error_at type="datetime" nil="true"></error_at> <finished_at type="datetime" nil="true"></finished_at> <started_at type="datetime" nil="true"></started_at> <test_code>saf2</test_code> <state>pending</state> <testing_application> <code>saf2</code> <name>Safari 2.0</name> <platform>Mac OS</platform> </testing_application> <result_images type="array"> <result_image> <image_type>window</image_type> </result_image> <result_image> <image_type>full</image_type> </result_image> </result_images> </result> ... </results> </test_set_version>

More Customer API articles: