Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.userpilot.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Sending tracked events and passing them to Userpilot is an easy and straightforward approach by calling the tracking method. This is the technical approach for sending tracked events from both Web and Mobile applications, which could contain metadata (event properties). We also support creating tracked events through Userpilot content by clicking on a certain button, and directly creating the tracked events from the events dashboard.

​
Use Cases

  • Trigger content based on user behavior
  • Analyze visitors’ behavior and activity on your web app
  • Identify how much users are interacting with a certain element of your product
  • Defining a goal using events to measure the impact of your in-flows on user behavior
  • Enable business teams to make efficient decisions about increasing the effectiveness of their digital marketing activities

​
Tracked Events Function

Sending tracked events and metadata to Userpilot by calling the userpilot.track() function.
You can have up to 10,000 unique event names and 512 KB total size per application. If you’re approaching or hitting these limits, it’s a sign to revisit how you’re sending events.Don’t use userpilot.track() for every click or input with dynamic IDs in the name (e.g. button-click-976728). For those, use auto-capture and labeling instead, you get one stable event per interaction type without hitting the limit.Do reserve tracked events for things only your app can tell product teams about (payments, DB changes, key state changes) and put the detail in metadata, e.g. userpilot.track("List toggle", { listId: "976728" }) instead of a new event name per ID eg. list-toggle-976728.
//tracking your events using the Track method
<script>
userpilot.track("Event");
</script>
//Specify more information about your event (metadata)
<script>
userpilot.track("Created an Invoice", {
 number_of_invoices: 2,
});
</script>
//Another example
<script>
var meta = {URL: "/growth"};
userpilot.track("Page Event", meta);
</script>

​
Button Tracked Events

Userpilot can track events through button clicks by enabling the Track event function for any button within the Userpilot content. Once the user clicks on the button after publishing the related content, data is sent to your Userpilot account showing the tracked event data.
The event needs to occur at least once (related button clicked/triggered live) to show in your dashboard

​
Tracked Events Dashboard

Once any Tracked Event has been sent to Userpilot it should be found in the Events Dashboard under the Events table. Entering an event will show the related analytics, in addition to the Overview chart that can be clicked to see the related event occurrences in a certain time period and the event metadata or any properties. In addition to the User/Company activity table that shows the total occurrences, and first/last occurrence of the event. There are also other ways to create tracked events such as directly creating them from the Events dashboard by adding the name and event key to track the event in your web app, then sharing it with your dev team to be called upon certain actions by your users. Sending tracked events through HTTP Rest API and the Bulk Data Import API is also supported.

​
FAQs

Tracked events would show right away, they’re updated in real time.
No, there is no current way to fully delete a tracked event, but they can be archived and won’t show anywhere in the app once done till they’re unarchived again.