English 
Español 
Portugues 
Français
Coremetrix API
The Coremetrix Report API facilitates the retrieval of attempt information and scores. This section covers the process of polling the API and checking the resource status until the required information is available..
The attempt status can be one of the following:
| Status | Description |
|---|---|
| INCOMPLETE | Quiz is yet to be completed, no scores will be present |
| COMPLETED_SCORED | Quiz has been completed, expect scores present for all enabled models. |
| COMPLETED_PARTIALLY_SCORED | Quiz has been completed, expect scores present for some models and flags present for other models. Note that not all quizzes have multiple models deployed. |
| COMPLETED_NOT_SCORED | Unable to score quiz, possible reasons: quiz was answered too fast (no profile will be generated and a FAST_CLICK flag will be present instead), no models have been set up / enabled, etc. |
Some extra information can be deducted by observing the timing information:
| timestamp | Description |
|---|---|
| landing | Quiz landing has been loaded in the browser but but the user has not progressed any further. |
| load | Quiz has been loaded in the browser but no answer has been submitted |
| load + start | Quiz has been started and at least one answer has been submitted |
| load + start + complete | Quiz has been completed, all answers have been submitted |
Attempts report by custom id
The API can return one report if we filter by customId. The custom id should be the same puid used when taking the quiz..
{}
]
}
},
],
}
}
Attempt by attempt id
The API can return one attempt by id.
{}
},
},
],
}
}
Batch attempts report (7 days)
The reports can be filtered by quizId and a date range. quizId, from and to query params are optional. The dates are in ISO8601 format, if dates are not provided then to defaults to the current date and time, and from defaults to seven days earlier than to. The maximum difference between from and to cannot be greater than 7 days.
Test attempts are filtered out by default but can be made explicitly available by the includeTest parameter.
Note: /report/attempts?quizId=63f751bb-7a2b-4c86-bfbc-217c1104b36e&from=2019-07-01T00:00:01Z&to=2019-07-05T16:01:02Z&includeTest=true
{}
]
},
]
}
},
},
]
}
},
],
}
}
}
]
}
},
],
}
}
Consent
The Consent APIConsent API returns information about users consent.
{}
},
},
],
}
}