ComputedResult

Models a result of a (set of) user(s) on a (set of) quiz(zes). It can be :

  • A detailed result : the result of a user on a quiz
  • An aggregated result : the result of a set of users on a quiz, or the result on a user on a set of quizzes.

Supertype

Item

Subtypes

None

JSON Representation

Detailed result

{
    "id" : string,
    "userId" : string,
    "quizId" : string,
    "sessionId" : string,     
    resultType_1 : number   
    ... 
    resultType_n : number 
}

Aggregated result, group by user

{
    "id" : string,
    "userId" : string,
    "aggregationFunction" : string,
    resultType_1 : number   
    ... 
    resultType_n : number
}

Aggregated result, group by quiz

{
    "id" : string,
    "quizId" : string,
    "aggregationFunction" : string,
    resultType_1 : number   
    ... 
    resultType_n : number  
}

Fields description

Field Meaning Constraints
id Identifier of the result. Valid API item identifier.
userId Identifier of the user that obtained this result. Valid API item identifier. Absent if results are grouped by quiz.
quizId Identifier of the quiz on which the user(s) obtained this result. Valid API item identifier. Absent if results are grouped by user.
aggregationFunction Aggregation function applied to compute this result. Optional.
  • If absent, the result is a detailed result : userId and quizId are both present.
  • If present, aggregationFunction is one of the following values : "min", "max", "average". Only one of the fields userId or quizId is present.
resultType_i
i=1..n 		The n result type(s) listed in the resultType parameter of the getResults API request. One of the following values : "nbGoodAnswers", "goodAnswersPercent", "percentile".