Periodic export
Export raw data periodically, e.g. for use with other analysis tools.
Enable the periodic data export feature
POST https://api-portal.evalytics/dataexport/enable
Be sure to save the private key in a safe place, you must be able to provide it when downloading exported files.
{
"enabled": boolean,
"privateKey": string
}Download a single periodically exported file
GET https://api-portal.evalytics.nl/dataexport/download
Query Parameters
file*
String
Possible values:
answerSetResult, answerSetTextResult, evaluation, evaluationBlock, evaluationBlockQuestion, evaluationBlockQuestionSet, evaluationBlockTeacher, evaluationCode, evaluationFeedback, evaluationFeedbackField, evaluationFeedbackTask, evaluationLabel, evaluationToLabel, organisation, question, questionLabel, questionScale, questionScaleValue, questionToLabel, subject, subjectGrade, subjectGradePeriod, subjectLabel, subjectToLabel, subjectTopicType, subjectTopicTypeTeacher, teacher, user, genericTopic, genericTopicToLabel, genericTopicLabel, genericTopicTopicType, topicType, year, period, subjectPeriod
fileType*
String
Possible values:
csv, json
privateKey*
String
The private key (encryption key) that was created when the periodic export feature was enabled
parseJsonDataTypes
Boolean
Ensures the data types in the JSON files are conform the data model
{
// Response
}Download all periodically exported files as a zip
GET https://api-portal.evalytics.nl/dataexport/downloadAll
Query Parameters
fileType*
String
Possible values:
csv, json
privateKey*
String
The private key (encryption key) that was created when the periodic export feature was enabled
parseJsonDataTypes
Boolean
Ensures the data types in the JSON files are conform the data model
{
// Response
}Disable the periodic data export feature
POST https://api-portal.evalytics.nl/dataexport/disable
Query Parameters
deleteSettings
Boolean
Removes previously exported files and invalidates the private key
{
"enabled": boolean
}Data model
Last updated