{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/learner/course/:collectionType/performance","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"collectionType\t=\t“assessment”\t\n{\t\n\"usageData\"\t\n: [\n\t \t\n{\t\n\"collectionId\": \"8c256e4a-4b37-423c-82b6-82fd8a128af2\",\t\n\"timeSpent\": 123456,\t\n\"scoreInPercentage\": 20,\t\n  \"attempts\"\t: 10,\t\n\"status\":\t\t\n\"complete\"\t\n\t\n},\t\n{\t\n\"collectionId\": \"18943604-108f-4b68-b4b1-b1b40ba6ba22\",\n\"timeSpent\"\t: 428342,\t\n\"scoreInPercentage\": 50,\t\n\"attempts\"\t: 10,\t\n\"status\"\t:\t\"complete\"\t\n\t},\t\n{\t\n\"collectionId\": \"aaa5e73a-2372-46a5-8344-4feeab1c9f1d\",\t\n\"timeSpent\": 42423\t\n,\t\n\"scoreInPercentage\"\t: 60,\t\n\"attempts\": 10,\t\n\"status\":\t\"complete\"\t\n\t\n}\t\n],\t\n\"userId\": \"95a744e1-631e-4642-875d-8b07a5e3b421\"\t\n}\t\n\tcollectionType\t=\t“collection”\t\n\t\n{\t\n\"usageData\": [\n\t \t\n{\t\n\"collectionId\": \"8c256e4a-4b37-423c-82b6-82fd8a128af2\"\t\n,\t\n\"timeSpent\": 123456\t\n,\t\n\"views\": 1\n\t \t\n}\t\n,\t\n{\t\n\"collectionId\": \"18943604-108f-4b68-b4b1-b1b40ba6ba22\"\t\n,\t\n\"timeSpent\": 428342\t\n,\t\n\"views\": 5\n\t \t\n}\t\n]\t\n,\t\n\"userId\": \" 95a744e1-631e-4642-875d-8b07a5e3b421\"\t\n}","name":""}]},"settings":"","params":[{"name":"collectionType","type":"string","default":"","desc":"collections/assessments","required":true,"in":"path","ref":"","_id":"5d43f4f685775c00ebeee303"},{"name":"courseId","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5d43f4f685775c00ebeee302"},{"name":"unitId","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5d43f4f685775c00ebeee301"},{"name":"lessonId","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5d43f4f685775c00ebeee300"},{"name":"startDate","type":"yyyy-mm-dd","default":"","desc":"“\t YYYY-MM-DD\t ”","required":false,"in":"body","ref":"","_id":"5d43f4f685775c00ebeee2ff"},{"name":"endDate","type":"yyyy-mm-dd","default":"","desc":"“\t YYYY-MM-DD\t ”","required":false,"in":"body","ref":"","_id":"5d43f4f685775c00ebeee2fe"},{"name":"userId","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5d43f4f685775c00ebeee2fd"},{"name":"classId","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5d43f4f685775c00ebeee2fc"}],"examples":{"codes":[{"language":"text","code":"http://nile.gooru.org/api/nucleus-insights/v2/study/assessment/performance?userId=95a744e1-631e-4642-875d-8b07a5e3b421&courseId=8c256e4a-4b37-423c-82b6-82fd8a128af2&unitId=9d367e4a-4b37-423c-82b6-82fd8a128ag3&lessonId=8c256e4a-5c48-534d-93c7-82fd8a128af2"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Overall Performance : Get Assessment/Collection Performance in Course","type":"endpoint","slug":"get-assessmentcollection-performance-in-course","excerpt":"","body":"","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d43f1f6f93f8d00f1f09acf","project":"56439dfe9eebf70d00490d54","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["5864d2df79ce642d00f0fec8","5864d2df79ce642d00f0fec9","5864d2df79ce642d00f0feca","5864d2df79ce642d00f0fecb","5864d2df79ce642d00f0fecc","5864d2df79ce642d00f0fecd","5864d2df79ce642d00f0fece","5864d2df79ce642d00f0fecf","5864d2df79ce642d00f0fed0","5864d2df79ce642d00f0fed1","5864d2df79ce642d00f0fed2","5864d2df79ce642d00f0fed3","5864d2df79ce642d00f0fed4","5864d2df79ce642d00f0fed5","5864d2df79ce642d00f0fed6","5864d2df79ce642d00f0fed7","5864d2df79ce642d00f0fed8","5864d2df79ce642d00f0fed9","5864d2df79ce642d00f0feda","5864d2df79ce642d00f0fedb","5864d2df79ce642d00f0fedc","5864d2df79ce642d00f0fedd","5864d2df79ce642d00f0fede","598aa64f4b6e990019b7a2d2","599bc76bc03fa2000f83db2a","599bcc3c3c5bf7000f3434fc","5d427dc9fa56fa0011135058","5d429c616863d5003af785a7","5d429e0889418f00c5e95d3f","5d42b5f098b05e003acb08b4","5d43c16985775c00ebeede3b","5d43d15446d584003da91e6d","5d43d61a5bdac50011b6f234","5d43d7c2db365100640dbc58","5d43d954bffa8400ff7efa78","5d43e414cf4f03005944344c","5d43eb42db365100640dbe4a","5d43ee6c78121b0057bc1dbf","5d9a18b4afc33400126c4e6f","5dc4f96dbb5da3006c8f5660"],"_id":"5864d2df79ce642d00f0fec7","createdAt":"2016-12-29T09:09:51.074Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2016-12-29T09:09:51.074Z","__v":18},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"New\tClass Performance APIs\tfor NILE","slug":"newclass-performance-apisfor-nile","order":35,"from_sync":false,"reference":false,"_id":"5d43e414cf4f03005944344c","project":"56439dfe9eebf70d00490d54","version":"5864d2df79ce642d00f0fec7","createdAt":"2019-08-02T07:19:48.122Z","__v":0},"user":"5d411a29005b9600113731fd","createdAt":"2019-08-02T08:19:02.933Z","__v":3,"parentDoc":null}

getOverall Performance : Get Assessment/Collection Performance in Course


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

collectionType:
required
string
collections/assessments

Body Params

courseId:
required
string
unitId:
string
lessonId:
string
startDate:
yyyy-mm-dd
“ YYYY-MM-DD ”
endDate:
yyyy-mm-dd
“ YYYY-MM-DD ”
userId:
required
string
classId:
string

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}