The Scheduling Widget integrates with Google Tag Manager for advanced user behaviour tracking and analysis.
This integration enables data collection through a data layer triggered during booking events. This provides insights into user interactions and booking patterns, which can be leveraged for optimisation and analysis within your analytics platform or the host website.
How was this solved?
The scheduling widget now supports the integration of Google Tag Manager directly in the source code. Along with provision of a detailed data layer that is triggered during booking events, allowing you to track events, and pass these either directly to your analytics platform, or up to the host website.
What events are triggered?
The three different outputs of a booking are triggered, specifically Bookings, Reschedules, and Cancellations.
The exact event names are displayed in the data layer as follows:
- bookingCompleted
- bookingRescheduled
- bookingCancelled
What parameters does the data layer contain?
Multiple data points are provided allowing you to either have unique parameters that can be used to join up to deeper analytics from the reporting API, or to allow you to better understand if the booking is from a new client or returning client.
The following data points are included:
| Data points | Description |
booking_api_hash | A unique reference to the booking. Use this to join to data from the reporting api. |
appointment_ids | Internal appointment Ids that are unique to the scheduling platform. Can be used to lookup data from the reporting api. |
| pms_appointment_ids | Unique ids of the appointment as provided by the practice system when it was created. Can be used to look up where the appointment is in your own data stores. |
| clinic_name | The name of the clinic as defined in the scheduling admin interface. |
clinic_reference_id | The reference of the clinic as provided by the corporate. (not always used), could be null |
is_new_client | If true, the pet parent has indicated they are a new client and gone through the new client booking flow. |
**Multiple values are captured for the ‘Appointment ID’ and the ‘PIMS appointment ID’ fields if a multi-pet booking is made.
How to enable GTM tracking for a Vet Group.
Note: We strongly recommend that a unique containerID should be created in google tag manager specifically for use with the scheduling platform. This will prevent unexpected impact from other scripts etc. that are triggered on the host website if the same containerID is used.
1. First to reach out to our support team on [email protected] and request to enable the “Capture Google Tag Manager Container ID” setting.
2. Once this setting is activated, navigate to Clinic > Advanced Settings > Tracking. You can now see a field called ‘Google Tag Manager Container ID’.
3. Enter the ‘Google Tag Manager Container ID’ and click ‘Save Changes’ button.
How is Booking Information Captured in the Data Layer?
The screenshot below illustrates the booking confirmation screen. This information can be found in the data layer of the Vetstoria booking tool.
This screenshot was captured from the ‘GTM-Tag Assistant’ tool that shows the ‘bookingCompleted’ event details are captured and reflected in the data layer.
If you have any questions or if you need further help, please login to Vetstoria to chat with our team or use the Contact Support form linked at the top of this page.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article