Information Available From The API

Formatted Reports

Converting the raw results into a set of customized diagnostic information that your customer can use will entail some work by your web developer. If you like the way the data is presented within the web site, or if you need to provide a report quickly while you build your own customized report, this presentation is prepared for you in two forms: HTML that can be presented in an “I-Frame” on your web site, and in a PDF document that can be downloaded.

Unformatted Data

Test Configuration

The test configuration provides:

  • Test ID
  • Name
  • Version
  • Description

These are the tests that will be run when the next email test is run. The complete list of tests is presented in a later section. A typical test configuration looks like this:

Test ID

 69

Name

 CA Anti-Spam 2007

Version

 5.1

Description

 CA Anti-Spam incorporates the Qurb platform.

Raw Test Results

Once a test is run, you can obtain the raw results. The following information is available for each test that was run:

  • Test ID                        a unique key for this instance of the test
  • Message ID                the ID assigned to the message by your email service
  • Result                          a numeric value indicating whether the test was run
  • Score                          a numeric value summarizing the result of the test                
  • App ID                       provides a key to match the results with the description
  • Filter ID                      you can ignore this field
  • App Priority                the report tab that will display this test         
  • Dashboard Priority      the level of the test within the result tree displayed on the tab
  • App Remedy              an indication of the server’s method of handling your email
  • Remedy                      what you can change to change the server’s response
  • Reason                       the reason for the server’s response
  • Explanation                 a broader explanation of the server’s response.

 

The following is a typical test result (coded values are defined in a later section):

Test ID

 3237159

Message ID

 003c01cb30c5$7f526d30$7df74790$@com

Result

 1

Score

 2

App ID

 33

Filter ID

 2863

App Priority

 2

Dashboard Priority

 3

App Remedy

 SpamButcher has identified your message as Spam.

Remedy

 To remove this flag first remedy the Spam Assassin flags and retest.

Reason

 Fuzzy logic fail.

Explanation

 This content based filter using fuzzy logic has recognized certain spammy elements in your message.

 

Formatted Reports

Converting the raw results into a set of diagnostic information that your customer can use takes some work. If you like the way the data is presented within the web site, or you need to provide a report quickly while you build your own report, this presentation is prepared for you in two forms: HTML that can be presented in an “I-Frame” on your web site, and in a PDF document that can be downloaded.

HTML

The HTML report presents the screen captures, test results that were prepared and the email message that was tested in a complete multi-tab report. While you can hide some of the information in this HTML report to fit your needs, the document is quite complex and we do not recommend editing it.

PDF

The test results are also presented in a PDF document. Some of the contents of the document are defined in your account layout. The settings that were chosen when the test was run are those used to prepare the document. Changing the settings will not modify the PDF document unless you resend the test email message.