Feedback collection
Collect ratings and emails from your visitors
AudioGuideKit includes built-in features to collect visitor feedback: star ratings, written feedback, and email signup.
Turning feedback on or off
Feedback is on by default: a rating button appears on the tour start screen. To remove it, set collectFeedback to false in metadata.json:
{
"id": "barcelona",
"collectFeedback": false
}With false, both the rating button and any rating stops in the tour are removed.
Star ratings
How it works
- Visitor taps the feedback button on the start screen
- Bottom sheet slides up with 1-5 star selection
- After selecting stars, a text field appears for written feedback
- Visitor writes feedback and taps Next
- Optional email collection step (can be skipped)
- Thank you message
The full flow collects: star rating + written feedback + optional email.
Adding a rating stop
For a more prominent feedback request, add a rating stop in your tour feed:
{
"id": "8",
"type": "rating",
"question": "How was your tour?",
"description": "Your feedback helps us improve"
}This creates a card with star selection that opens the full feedback sheet when tapped.
Place rating requests near the end of the tour, after visitors have experienced enough to form an opinion.
Email collection
Collect email addresses for newsletters or follow-up communication.
Adding an email stop
{
"id": "9",
"type": "email",
"title": "Stay in Touch",
"description": "Get notified about new tours and special events.",
"placeholder": "Enter your email",
"buttonText": "Subscribe",
"consentText": "I agree to receive emails about new tours."
}All fields are optional and have sensible defaults from the UI translations. With consentText, the form shows a checkbox with that text, and the visitor must tick it before submitting.
What visitors see
- Card with title, description, and email icon
- Email input field with your placeholder text
- Submit button with your button text
- Success message after submission
Where the data goes
Every rating is saved in the browser's localStorage, so the player knows the visitor has already rated this tour:
{
tourId: string;
rating: number; // 1-5 stars
feedback: string; // Written feedback text
email: string; // Only if the visitor subscribed
submittedAt: string; // ISO timestamp
}To receive ratings and email addresses yourself, give the build an analytics endpoint. The player then sends:
- a
feedback_submitevent with the rating and the comment, once per device and tour; - an
email_submitevent when a visitor submits an address from an email stop, or subscribes in the rating sheet's email step (which always asks for consent first).
Without an endpoint nothing leaves the device: the email form shows its thank-you card and sends nothing. The Analytics page explains how to set an endpoint and what your server receives.
Ratings follow the visitor's privacy settings: with Global Privacy Control or Do Not Track on, no feedback_submit event is sent. An email address is still sent, because the visitor typed and submitted it on purpose.