API Reference

Index

Here are some descriptions of the more important attributes you will find in the API.

  • Id: The most important property. This is the unique identifier for your EmailTests, SpamTest, and individual result from TestingApplications.

  • ApiId: This code references the platform for the specific test result. It will match the ApplicationName property of the results collection.

  • SupportsContentBlocking: This value indicates true if the requested client supports content blocking and false if it does not. Content blocking clients, sometimes referred to as image blocking, will return different result images for ImagesOn and ImagesOff.

  • ResultImageSet: The ResultImageSet, as the name would suggest, is the collection of images that makes up your completed test. It consists of two main blocks ImagesOnUrls and ImagesOffUrls. Each main block contains two sub blocks for WindowUrls and FullPageUrls. Further, each capture block contains an ImageUrl and ThumbUrl. For clients that do not support content blocking the outerblocks (ImagesOnUrls and ImagesOffUrls) will be identical. For clients who do support content blocking (SupportsContentBlocking == true) the ImagesOffUrl will show the blocked versions and ImagesOnUrl will show the non-blocked versions.

  • State: Indicates the current status of your test. By the time you receive a callback Completed will be true. Values include: pending, deferred, failed, completed, canceled.

  • CallbackUrl: This is the Url Litmus will post test results to.

  • SpamResult:

  • SpamScore: Numerical spam indicator returned by the particular Spam filter.

  • IsSpam: Boolean indicating if this particular filter deems the message to be spam or not.

  • SpamHeaders: Each header consists of a key, description and rating indicating it's severity.

  • Status: Indicates the current status of the testing application on the Litmus platform. This will return an integer value of 0,1 or 2. 0 indicates the application is available and processing tests, 1 indicates we're currently experiencing some issues with the applications and 2 indicates the applications is currently unavailable for testing. You can also visit https://status.litmus.com/ to find out about any issues affecting our platform.