Skip to main content

Getting additional data from Nookal

This procedure is only useful for tenants connected to Nookal who are wanting additional types of data

Most of your Nookal data is available via the Nookal API, including data about locations, practitioners, patients, appointments, service types and more. There is some data that is not currently available via the Nookal API such as:

Type of data Nookal Page
Cancellation Reason Cancellations Report
Pass Types and Redemptions Pass Redemptions Report + Settings/Inventory/Passes
Online Bookings Online Bookings Report
Practitioners (provider number, DOB) Settings/Staff
Occupancy / Utilization Occupancy Report

The BOS can operate without this data, but being able to collect this data as well will give you additional business insights such as:

  • Practitioner FTE and Utilization Rate
  • Why are clients cancelling appointments?
  • Which appointments were booked online
  • Practitioner Birthday Reminders

How can we get this data?

As this data isn't in available in the Nookal API our only other method of data collection is for The BOS to log in to your nookal account, generate the report and 'read' the data itself. This automated process is often referred to as 'scraping'. 

To do this you must provide The BOS with a username and password that has access to generate these reports in your Nookal Account. Once you have provided that data The BOS will continue to do normal data collection via the Nookal API but will additionally scrape the additional information. 

It is very important that you create a separate staff member in Nookal for this, do not enter your own Nookal login details!

  1. Log in to Nookal, go to the settings page and make a new user with access to the locations you want data on, and sufficient level of permissions for them to generate the reports
  2. We recommend using "obvious" details for this user, so a name like "The BOS" and email address of thebos@<your-company-name>. Please choose a very complicated password.
  3. Once that is done, log in to The BOS, go to User Menu, Settings, Connections, Nookal. 
  4. Under 'Scraper Login' click edit then enter your nookal company ID as well as the email and password of the account you created above. 
  5. No additional data will be instantly imported. On the next scheduled data update (at least once per day) your extra data should now be imported. 

If you experience any difficulties setting this up please contact support.