Back to Customer API documentation

Data Reference: 

Parameter:     check_state

Type:              string

RO/RW:          read-write

The check_state attribute indicates the compatibility flag as set by a user. This changes how a result appears in the Litmus web app (red cross or green tick), you are free to set this parameter and use the data yourself via the results/update method. Either 'ticked', 'crossed' or 'nostate' are allowed as valid values. A result which returnsnil for check_state is considered to be 'nostate'. But you cannot set this value as nil yourself, you must set 'nostate'  if you want to clear the compatibility state. 

Parameter:     error_at

Type:              date/time

RO/RW:          read-only

If an error occurred during the capture process then this value will be set to a date/time value. This also indicates that the test is complete and no further testing will occur unless you try to retest this particular result.

Parameter:     finished_at

Type:              date/time

RO/RW:          read-only

If the test completed successfully then this attribute will be set to a date/time value and will indicate when the testing system processed the result.

Parameter:     id

Type:              integer

RO/RW:          read-only

A unique integer identifier assigned to each result by Litmus. 

Parameter:     started_at

Type:              date/time

RO/RW:          read-only

This date/time value indicates when Litmus begun processing this particular result.

Parameter:     test_code

Type:              string

RO/RW:          read-only

Identical to the application_code of the testing application used to process this result. It's presence in the API is a left over from previous versions to ensure backwards compatibility. We recommend you use the Result/Testing Application/Application code parameter instead of this value.

Parameter:     state

Type:              string

RO/RW:          read-only

Similar to the state attribute on the test version, but with subtle differences in the states returned. Possible values are:

• Error - this test could not be completed for some reason. You can try to retest but the error may be due to problems specific to the page/email you are trying to test and so you may need to contact us at hello@litmus.com if you repeatedly get error state for the same result.
• Complete - this test has completed and results are available
• Pending - this test has not begun processing yet

Parameter:     result_type

Type:              string

RO/RW:          read-only

Indicates whether this result is a page, email or spam result. You will only get spam results if you carried out an email test and may get a mixture of spam and email result_types within a result array.