Back to Customer API documentation

Customer REST API Method: versions/poll

To reduce the strain on the Litmus servers, and to reduce the bandwidth you use to check for test completion, there is a special poll method that can be used. The XML document returned will give an indication as to the status of each result. You may want to wait for every result to complete, or you may wish to return each result as it completes. You can check the status of the poll method and fetch the whole test version when the state for a particular result changes.

URL:

https://#{company}.litmus.com/tests/#{test-id}/versions/#{version}/poll.xml

HTTP Method(s):

GET

Parameters:

• test-id.  Required. The ID of the test you wish to retrieve
• version. Required. The version you wish to poll.

Response: 

          XML example: 

<?xml version="1.0" encoding="UTF-8"?>
<test_set_version>
  <version type="integer">3</version>
  <results type="array">
    <result>
      <id type="integer">1149860</id>
      <test_code>ie7</test_code>
      <state>pending</state>
    </result>
  </results>
</test_set_version>