06Error tracking

Feedback widget

The feedback widget puts a small button on your site. People use it to take a screenshot and mark it up, record a video of the tab, or just write to you. Each note lands in Errors & feedback → Feedback, linked to the error the person most likely ran into, so you see how many others it hit.

Turn it on

Add the attribute

Add data-feedback to the snippet's <script> tag:

<script defer src="https://api.snowanalytics.app/sa.js" data-site="YOUR_SITE_ID" data-feedback></script>

The tracker then loads a second script, sa-feedback.js, from beside sa.js. A page without the attribute never fetches it. The screenshot editor, sa-feedback-shot.js, loads when someone picks Take a screenshot, and the recorder, sa-feedback-video.js, when someone picks Record a video.

On the SnowAnalytics packages, set feedback: true in the options instead.

Choose how it looks and behaves

Site settings → Feedback widget shows the widget on a stand-in of your site as you change it, on a computer or a phone. You can try it there; nothing you send from the preview arrives. Changes reach your site within five minutes of saving, without touching the snippet.

If you forward SnowAnalytics through your own domain, add the widget's four paths to the proxy. See Session replays, error tracking and feedback.

What people can send

The button opens up to three choices. You can turn each one off or reword it, in Settings or from your code:

  • Take a screenshot. The screen freezes and dims, as with your computer's own screenshot tool. People drag over the part that matters, or click for the whole screen. Share copies the image, downloads it, or opens the system's share sheet. People can take several, and edit or remove each one before sending.
  • Record a video. After a 3-2-1 countdown, the widget records the tab while people show what happens, for up to 2 minutes, with their voice if they allow the microphone, which they can mute and unmute without stopping. It records the page itself, not their screen, so there's no screen-sharing prompt. While recording, Draw lets them circle or point at things on the page; the ink fades a few seconds after they stop, and it plays back in the video at the moment it was drawn. They can trim the start and end before using it, click anywhere along the timeline to jump there, and watch it full screen (F). A note can carry up to 3 videos.
  • General feedback. Just the note.

On a screenshot, the toolbar has one button per tool, each with its own key:

  • Point (P), which picks out part of the page the way a browser's element inspector does. It outlines the button, card, chart or text under the cursor, and scrolling steps out to what's around it and back in.
  • Rectangle (R), Ellipse (O), Arrow (A) and Pen (D).
  • Text (T), plain, outlined or on a pill of its colour, in five sizes.
  • Hide (H), which blacks out anything private: click it, or drag over an area.
  • Select (V), to work on marks without drawing new ones.

The colour and text size buttons beside the tools change the selected mark, and whatever is drawn next.

Every mark stays editable, as in your computer's own screenshot tool. Click one with any tool to select it, then drag it to move it, or drag its handles to resize it or move an arrow's ends. Click text with the Text tool, or double-click it, to retype it. Arrow keys nudge the selected mark and Delete removes it. ⌘C or Ctrl+C copies the screenshot, ⌘↵ or Ctrl+Enter finishes it, and every change can be undone and redone.

Points and drawings are numbered, and each is named after what it marks, such as button · Add to cart or chart · Sales this week. A drawing that doesn't mark anything in particular is named after its shape. Words under a hidden area never go into a name.

Screenshot and Video stay under the text box, so people can add more of either (up to 8 screenshots and 3 videos). The note can also carry a voice note, which people can play back and skip through before sending, and up to 5 files (images, PDFs or text). People can change the email address replies go to. After sending, they can rate their visit with up to 5 stars.

On a phone, the widget opens as a sheet from the bottom of the screen. The widget follows your page's light or dark look as it changes. Its menu, its note and its thanks end with a small Powered by SnowAnalytics line.

The button

Site settings → Feedback widget → Button picks how people find the widget. Each one sits on the left or the right of the screen, in your brand's colour:

  • Bubble, a round button in the corner. After a few seconds it tucks into a small tab at the edge of the screen, clear of the scrollbar, so it never covers your page. Resting the pointer on the tab brings the button back, and people can drag it up or down the edge.
  • Labelled, a button that says Feedback, or your own words in Text. It folds into a round close button while the widget is open.
  • Side tab, a tab halfway down the edge of the screen, its words running up it. The widget opens beside it.
  • Handle, the small tab at the edge from the start. Pointing at it brings the button out.
  • Your own, which draws nothing. The widget opens from your own button or link, from your code, or when it asks after rage clicks or an error.

On the SnowAnalytics packages, update to the latest version for these; older versions show the bubble.

Open it from your own button

Give any button or link data-snow-feedback, and a click on it opens the widget:

<button data-snow-feedback>Send feedback</button>

This works whichever button you picked, so a Report a bug link in your menu can sit beside the bubble. From your code, snow("feedback") does the same; on the SnowAnalytics packages it's feedback().

Settings

SettingWhat it does
ButtonHow people find the widget: Bubble, Labelled, Side tab or Handle, on the left or the right, with your own words on the labelled button and the tab. Your own draws nothing; see The button.
Ask after rage clicksOffers the widget once a visit, when someone clicks the same thing again and again.
Ask after an errorOffers the widget once a visit, after an error breaks the page.
OptionsWhich of Screenshot, Video and General feedback the widget offers, each with its own Title and Line under it. Left blank, they keep the widget's words. At least one stays on, and turning off Screenshot or Video also drops it from under the text box. Video also needs Screen recordings and voice notes on.
LookUntil you change it, the widget takes the font, the main colour and the corner style from your pages. Set a Colour or round, soft or square Corners to use your own, and the Match link under them goes back to your site's look.
Diagnostic dataLets people send the page's last console errors and failed requests with the note. They can untick it on each note.
Screen recordings and voice notesOff, the widget offers screenshots and text only.

Passwords and card numbers are always hidden: they are blanked in screenshots and never recorded.

Choose the options from your code

To offer different choices on some pages, set window.SNOW_FEEDBACK_OPTIONS before the menu opens. It wins over Site settings for the choices it names and leaves the others as they are. false hides a choice, true shows it, and words rename it and show it:

<script>
  window.SNOW_FEEDBACK_OPTIONS = {
    screenshot: { title: "Report a bug", hint: "Show us where it happens" },
    video: false,
    general: { title: "Suggest an idea" },
  };
</script>

The widget reads it each time the menu opens, so a single-page app can change it as people move around. On the SnowAnalytics packages, call feedbackOptions() with the same object:

import { feedbackOptions } from "@kapybara/snowanalytics/next/client";

feedbackOptions({ video: false, general: { title: "Suggest an idea" } });

If every choice ends up hidden, the widget still offers the plain note.

Reading the notes

Errors & feedback → Feedback lists every note with its screenshot, the person's stars, how many people it reaches, what's at risk and its state. Open one to see its screenshots and numbered marks, play its recordings or voice note, reply, and mark it done. The screenshot card can take the dialog's full width or go full screen.

  • Problems and feedback. A note started from a screenshot or a video, or one the widget asked for after an error, is a Problem. A general note is Feedback. You can change it.
  • Linked to the error. When the person's visit hit an error in the 30 minutes before they wrote, the note links to that issue. Its row then counts the people the error hit and the revenue at risk, and the issue shows the note under What people said.
  • Notes that say the same thing are merged. A request that says the same as an open one counts on that one, so 40 people asking to pause a subscription read as one note from 41 people.
  • Spam and empty notes are held back. They stay under Held back, out of the counts and the alerts.

Emails in your site's name

When a person leaves an address, SnowAnalytics emails them under your site's name:

  • We got it, as soon as the note arrives. Links in the note are left out of it, and an address gets at most three a day.
  • Your replies from the note's conversation. Their answer comes back to your inbox.
  • It's fixed, when you mark the note done or resolve the error it came from, if the note's Email … when it's fixed switch is on. Resolving an error marks its open notes done.

To be told about new notes yourself, add a Someone sends feedback rule in Alerts.

Privacy

  • Screenshots and recordings are taken in the browser, of your page only. Password and card fields are blanked, and Hide blacks out anything else before the note is sent.
  • Recordings keep form fields masked.
  • Diagnostic data is sent only when the box is ticked, with query strings, emails and tokens stripped.
  • Notes are stored with your site's data. Deleting the site deletes them.

On this page