Home Guide FAQS Getting Started API Contact

CONTACT US

BASICS

Get familiar with the foundations of the API using ping as an example.
Jump to Basics

ROOMS & USERS

Create rooms and invite users via the API or use the simple frontend.
Jump to Rooms

REPORTING

Query our rich reporting API for session data or view on the frontend.
Jump to Reporting


Basics

All API access must over HTTPS. POST requests must include your account and authentication token and must be posted to your subdomain. The API responds with a JSON object detailing success or failure of the request. In the case of failure, a reason is returned.

            
              {
                "account": yourAccount
                "authentication": yourToken
                "command": "PING"
              }
            
          
            
              {
                "status": "success"
                "result": "PONG"
              }
            
          

Rooms & Users

Normally you will invite tutors to create their own rooms using the Bramble sign up front end provided for your account which gives them choice over their room name and expose them to the tutorial flow. However, if you'd prefer to integrate this programatically into your own back end you can create rooms directly via the API. These will sit within your subdomain, and a 4 digit pin will added to the room codes.

            
              {
                "account": yourAccount
                "authentication": yourToken
                "command": "createRoom"
                "room": "JaneBloggs"
              }
            
          
            
              {
                "status": "success"
                "roomURL": "https://yourSubdomain.bramble.io/JaneBloggs2863"
              }
            
          

Reporting

We provide both agency & enterpise customers with a reporting service to analysise the usage & engagement of rooms within your account. Again, to integrate this more fully into your existing service, you can query specific requests via the reporting API for data ranging from session start and end time to the number of resources and strokes in a session.

            
              {
                "account": yourAccount
                "authentication": yourToken
                "command": "reporting"
                "fromdate": 2016-01-22
                "todate": 2016-10-15
                "filter": "Bloggs"
              }
            
          
            
              {
                "reporting" : {
                  "filter" : "Bloggs",
                  "rooms" : {
                     "JaneBloggs2863" : [
                        {
                           "Users" : [
                              {
                                 "User" : "tutor@email.com[Mac]",
                                 "Strokes" : 99,
                                 "Texts" : 91,
                                 "Resources" : 9,
                                 "SnapShot" : 0,
                                 "WebCam" : 1
                                 "Export" : 1,
                              },
                              {
                                 "User" : "student@email.com[Mac]",
                                 "Strokes" : 135,
                                 "Texts" : 18,
                                 "Resources" : 0,
                                 "SnapShot" : 0
                                 "WebCam" : 2,
                                 "Export" : 0,
                              }
                           ],
                           "start_time" : "2017-05-12 17:35:09",
                           "session_UID" : 1234,
                           "Notebooks" : [
                              {
                                 "notebook_UID" : "23rd-083b-4yy5-a2r9-2de00b39",
                                 "maxPage" : 10
                              }
                           ],
                           "end_time" : "2017-05-12 18:56:14",
                           "Duration" : 80
                        }
                    }
              }