User Details Reporting

Authentication:

Please see the API page for details on how to authenticate.

Endpoints

For user details reporting there are two endpoints available:

/account/{accountID}/reports/usersDetails/liveHelp?startDate={MM/dd/yyyy}&endDate={MM/dd/yyyy}&itemPerPage=100&page=xxx

/account/{accountID}/reports/usersDetails/writingLab?startDate={MM/dd/yyyy}&endDate={MM/dd/yyyy}&itemsPerPage=100&page=xxx

Parameters:

accountID is the accountID provided by Brainfuse for your account.

startDate is the startDate inclusive of the reporting period

endDate is the endDate inclusive of the reporting period

itemsPerPage is the number of items to display for each page default=100. Maximum 1000

page is the page number to return by default this is 1

Response:

liveHelp:

1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:
28:
29:
30:
31:
32:
33:
34:
35:
36:
37:
38:
39:
40:
41:

{

  "pages": {

    "numOfPages": 1, /* maximum number of pages available*/

    "__sessionId": "20211103_133052_013",

    "page": 1 /* current page number */

  },

  "LiveSession": [

    {

      "date": "2021-10-29T23:52:11.011Z",

      "username": "Brainfuse username xxxx",

      "subject": "Geometry",

      "account": "Account or Campus Name",

      "collegeID": "College ID",

      "courseName": "Course Name that the student used to login from the LMS",

      "minutes": 10,

      "source": "Brainfuse Instructors/Other",

      "ip": "IP Address used to login",

      "courseId": "courseId that the student used to login from the LMS"

    }

  ]

}

writingLab:

1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:
28:
29:
30:
31:
32:
33:
34:
35:
36:
37:
38:
39:
40:
41:

{

  "pages": {

    "numOfPages": 1, /* number of available pages */

    "__sessionId": "20211103_133626_250",

    "page": 1 /* current page index */

  },

  "WritingLab": [

    {

      "courseName": "Name of the course that the student used to login from the LMS if applicable",

      "account": "Account name or sub campus account",

      "uid": "Brainfuse UID",

      "courseId": "CourseID of the course the student used to login from the LMS if applicable",

      "minutes": 45, /*Number of minutes used for the writing lab*/

      "username": "Brainfuse Username of the student",

      "collegeID": "ID of the student from single sign-on",

      "source": "Brainfuse Instructors/Other",

      "subject": "Subject used ",

      "date": "2021-10-28T04:04:00.000Z"

    }

  ]

}