Skip to main content
Read a pre-test with GET /pretests/{id}.

Status

result is only filled when the status is completed. error is only present when it is failed.

Score and recommendation

  • result.score: overall score from 0 to 10. Can be null.
  • result.recommendation: launch, optimize or iterate, from most favorable to the one that needs the most work. Can be null.
  • result.recommendationLabel: the same text, ready to display, in the language of the result.
  • result.conclusion: conclusion paragraph.

Pillars

result.pillars is an object with a score from 0 to 10 for each evaluation pillar. The pillars vary by channel, so read the keys that come back instead of assuming a fixed list.

Findings

result.findings lists the checks made on the piece. Each item has:

Recommendations and maps

  • result.recommendations: suggested actions, each with title, description, priority (high, medium or low) and category.
  • result.maps: heatmap, contrast and focus, each null or with url and mediaType (image/jpeg or video/mp4).

Analysis PDF

The pre-test report.status shows the state of the PDF: pending, generating, ready, failed or unavailable. It stays pending until the PDF is generated. For OOH and digital, the PDF is usually generated on its own after the analysis finishes. For email, it is only generated when you ask for it. GET /pretests/{id}/report starts generation for any completed pre-test and returns the link when it is ready:

When it fails

A failed pre-test carries error.code: These codes appear in the pre-test’s error.code. Call errors (HTTP 4xx and 5xx) are in Errors.