Skip to the content
Menu: Results

Results

A result (res_…) is a scored session: a role-play marked against its rubric, an assessment, a lesson with a check at the end. Its id is the session's, with its own prefix. GET /v1/results lists them (with filters by portal, subject, unit, person and updatedAfter), and GET /v1/results/{id} reads one. Scope: results:read.

Results carry numbers: the score, the percent, pass or not, and each category's score. The words of the conversation (the report's summary, strengths, what to work on) stay in Zentiq.

The released rule#

A result is sent out only once it is final, and never when it belongs to the person alone:

The result isWhat the API and webhooks give
Released: marked, or decided by a reviewerIts numbers. After a review, the reviewer's decision.
Awaiting review: the marking sent it to a personThat it happened, with passed: null and no score. Nothing that hints at the outcome goes by webhook until a person decides.
Held from the person (results shown to reviewers only)No numbers, for good.
Voided by a reviewerNo score.
A practice attemptNothing: practice belongs to the person, and is never listed, sent or counted.

report.produced sends a released report's numbers, and assessment.completed sends the final outcome; when a reviewer decides, the final assessment.completed has an event id of its own, so a receiver that drops repeats still gets it.

Who a result is about#

A result names the person by id (usr_…), with your own externalId for them when you set one, so your HR or learning system can match it. Their name and email stay behind the people operations and their own scopes (people:read).