How do I track custom events?

The call

Once the TapCub script is on the page, send an event with a name and optional properties:

tapcub.track('signup', { plan: 'pro' });

If your code might run before the script has loaded, push onto the queue instead. Queued calls are sent as soon as the script starts:

<script defer src="https://static.pathclue.com/client.js" data-site="YOUR_SITE_KEY"></script>
<script>
  window.__tcq = window.__tcq || [];
  window.__tcq.push(['track', 'signup', { plan: 'pro' }]);
</script>

A failed call never throws an error on your page.

Naming rules

• Use snake_case, start with a letter, up to 40 characters, for names you register in the event catalog: signup, add_to_cart, video_play.
• Do not start names with $, _ or tc_; those are reserved. Names starting with a double underscore are used by automatic events.
• Do not rename an event once it is in use. The name is the key in your data; change the display name instead.
• Use the same name for the same action on web, app and mini program, so cross-platform analysis can combine them.

Property limits

Longer names and values are cut in the browser; the event is still sent. Objects and arrays are not stored as values. Only add properties you will filter or break down by, and never put raw input text such as names or emails in them.

The collector drops an exact repeat (same visitor, page, name and properties) within one second, so a double click does not count twice.

Where to see events

New events appear in Web analyticsEvents with count, distinct visitors and a 7-day trend. To name, describe or hide them, use the definitions tab of All-platform analyticsDataEvent inbox. For breakdowns and formulas, use event analysis. Reviewing names is covered in how to review event candidates.

Amounts and orders

Send purchases and other money amounts from your server, not the browser, so a closed tab or blocker does not lose them. See the developer docs.

Confirm it works

Do the action yourself on the live site, then open Web analyticsRealtime: the event appears within a few seconds. Totals and properties are in Web analyticsEvents.

See also: track button clicks and tracking plan.