{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/class/:classId/activity","auth":"required","method":"post","examples":{"codes":[{"language":"text","code":"http://nile.gooru.org/api/nucleus-insights/v2/class/73294a4d-8825-4106-8cc9-8c26f370d91z/activity?collectionType=assessment&UserId=95a744e1-631e-4642-875d-8b07a5e3b421&startDate=2017-03-12&endDate=2017-03-15\n\nBODY\t-\tJSON\t(application/json)\t\n\t\n{\t\n\"collectionIds\":\t[\"73294a4d-8825-4106-8cc9-8c26f370d91z\",\t\n\t\n\"73294a4d-8825-4106-8cc9-8c26f381e17d\",\t\n\t\n\"aaa5e73a-2372-46a5-8344-4feeab1c9f1d\"\t\n]\t\n}\t"}]},"results":{"codes":[{"status":200,"language":"json","code":"The\tAPI\twill\treturn\tdata\tfor\tboth\tTeacher\tas\twell\tas\tStudent.\tIf\tUserId\tis\t\npassed\tas\ta\tRequest\tParam\tthe\tAPI\tresponse\twill\treturn\tdata\trelated\tto\tthat\t\nUser.\t(Student).\tIf\tUserId\tis\tnot\tpassed\ton\tas\tRequest\tParam,\tthen\tdata\tfor\t\nall\tUsers\twill\tbe\treturned.\t\nCurrently\tfor\tCollections\tONLY\t\t\nTimespent\tand\tdate is\tto\tbe\tused,\t&\tfor\t\nAssessment\tONLY\tscoreInPercentage\tand\tdate is\tto\tbe\tused.Rest\tof\tthe\tfields\t\n\n\ncollectionType\t-\t“assessment”\t\n\t\n{\t\n\t\t\t\t\"usageData\":\t[{\t\n\t\n\t\"activity\":\t[{\t\n\t\n\t\"date\":\t\"2017-03-14\",\t\n\t\n\t\"collectionId\":\t\"dfde956f-dc37-49d9-b6d1-02cfe3229d47\",\t\n\t\n\t\"scoreInPercentage\":\t100,\t\n\t\n\t\"timeSpent\":\t72263,\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"lastSessionId\":\t\"cdde956f-dc37-49d9-b6d1-02cfe3229d89\",\t\n\t\n\t\"attempts\":\t3,\t\n\t\n\t\"status\":\t\"complete\"\t\n\t\n\t}],\t\n\t\n\t\"userId\":\t\"95a744e1-631e-4642-875d-8b07a5e3b421\"\t\n\t\t\t\t},\t{\t\n\t\n\t\"activity\":\t[{\t\n\t\n\t\"date\":\t\"2017-03-12\",\t\n\t\n\t\"collectionId\":\t\"dfde956f-dc37-49d9-b6d1-02cfe3229d47\",\t\n\t\n\t\"scoreInPercentage\":\t0,\t\n\t\n\t\"timeSpent\":\t9811,\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"lastSessionId\":\t\"258e956f-dc37-49d9-b6d1-02cfe3229dew\",\t\n\t\n\t\"attempts\":\t1,\t\n\t\n\t\"status\":\t\"complete\"\t\n\t\n\t}],\t\n\t\n\t\"userId\":\t\"df956d5f-b7b2-43ae-98a1-c90a12eacaf9\"\t\n\t\t\t\t}]\t\n}\t\n\ncollectionType\t-\t“collection”\t\n\t\n{\t\n\t\t\t\t\"usageData\":\t[{\t\n\t\n\t\"activity\":\t[{\t\n\t\n\t\"date\":\t\"2017-03-15\",\t\n\t\n\t\"collectionId\":\t\"2c90e0bf-f715-4c88-9da9-5513a6f52106\",\t\n\t\n\t\"scoreInPercentage\":\t0,\t\n\t\n\t\"timeSpent\":\t22281,\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n  \"lastSessionId\":\t\"NA\",\t\n\t\n\t\"attempts\":\t0,\t\n\t\n\t\"status\":\t\"complete\"\t\n\t\n\t},\t{\t\n\t\n\t\"date\":\t\"2017-03-15\",\t\n\t\n\t\"collectionId\":\t\"e998b952-448e-4912-9a1a-80c01ba50b04\",\t\n\t\n\t\"scoreInPercentage\":\t0,\t\n\t\n\t\"timeSpent\":\t9223,\n\n   \"lastSessionId\":\t\"NA\",\t\n\t\n\t\"attempts\":\t0,\t\n\t\n\t\"status\":\t\"complete\"\t\n\t\n\t},\t{\t\n\t\n\t\"date\":\t\"2017-02-27\",\t\n\t\n\t\"collectionId\":\t\"e998b952-448e-4912-9a1a-80c01ba50b04\",\t\n\t\n\t\"scoreInPercentage\":\t0,\t\n\t\n\t\"timeSpent\":\t15166,\t\n\t\n  \"lastSessionId\":\t\"NA\",\t\n\t\n\t\"attempts\":\t0,\t\n    \n  \"status\":\t\"complete\"\t\n\t\n\t}],\t\n\t\n\t\"userId\":\t\"95a744e1-631e-4642-875d-8b07a5e3b421\"\t\n\t\t\t\t},\t{\t\n\t\n\t\"activity\":\t[],\t\n\t\n\t\"userId\":\t\"df956d5f-b7b2-43ae-98a1-c90a12eacaf9\"\t\n\t\t\t\t}]\t\n}\t","name":""}]},"settings":"","params":[{"name":"classId","type":"string","default":"UUID","desc":"","required":true,"in":"path","ref":"","_id":"5d44056181cdf6003afcbb72"},{"name":"collectionType","type":"string","default":"","desc":"assessment/collection","required":true,"in":"body","ref":"","_id":"5d44056181cdf6003afcbb71"},{"name":"userId","type":"string","default":"UUId","desc":"","required":false,"in":"body","ref":"","_id":"5d44056181cdf6003afcbb70"},{"name":"startDate","type":"yyyy-mm-dd","default":"","desc":"“\t YYYY-MM-DD\t ”","required":true,"in":"body","ref":"","_id":"5d44056181cdf6003afcbb6f"},{"name":"endDate","type":"yyyy-mm-dd","default":"","desc":"“\t YYYY-MM-DD\t ”","required":true,"in":"body","ref":"","_id":"5d44056181cdf6003afcbb6e"},{"name":"collectionIds","type":"array_string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5d44056181cdf6003afcbb6d"}]},"next":{"description":"","pages":[]},"title":"Daily Class Activity: Get Assessment/Collection Performance for DAILY CLASS ACTIVITY (POST)","type":"endpoint","slug":"12-get-assessmentcollection-performancefor-daily-class-activity","excerpt":"","body":"","updates":[],"order":16,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d44056181cdf6003afcbb6c","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-02T09:41:53.032Z","__v":2,"parentDoc":null}

postDaily Class Activity: Get Assessment/Collection Performance for DAILY CLASS ACTIVITY (POST)


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

classId:
required
stringUUID

Body Params

collectionType:
required
string
assessment/collection
userId:
stringUUId
startDate:
required
yyyy-mm-dd
“ YYYY-MM-DD ”
endDate:
required
yyyy-mm-dd
“ YYYY-MM-DD ”
collectionIds:
required
array of strings

Examples


Result Format


User Information

Try It Out

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