Tracking

Overview

Envoy has a custom analytics tool that helps you monitor the overall actions of your users inside the Envoy environment. This system is already implemented inside of the landing page, implementing this inside your system is optional.

Setup

Tracking any type of events is done using our API.

Note

Checkout the API documentation here

Note

Pro tip

Using the extra field of the Pixel Event API, you can share anonymous data on user type or campaign (e.g. {"campaign": "christmas", "userType": "premium"})

Note

Make sure you only integrate these events if partner comes from Envoy, ie the envoy query params(envoy_share_link_hash, envoy_link_uuid) are present is in the linkout url.

Events

You can use two types of events used:

• Predefined: events used by our landing pages and implemented in our SDKs for Android and iOS
• Custom: These are events that you can setup and use. i.e Custom events for giving rewards to your users

Predefined Events

Event Name	Event Id	Description
Envoy Gift open	envoy_link_view	Triggered when a link is opened
Envoy CTA click	envoy_link_out	Happens when a user clicks on an offer
Email Collected on Landing	email_landing_collected	This is only present if a gift requires an email to unlock the content
App Downloaded	app_downloaded	After an app is downloaded and is open the first time
Account Creation	account_created	Triggers when an account is created
Trial Activation	trial_activated	Triggers when trial is activated
Payment	payment_success	Triggers when payment for the account is done

Custom Events

You can use your own custom events when for tracking user actions. Use the API just like you use it for the predefined events. These events will also be present in the CSV referred below.

Note

Please also check this section for naming conventions

Frontend related tracking

For tracking frontend related events in your systems be they mobile, web or otherwise you need to follow the next steps.

Note: This functionality is already implemented in our iOS and Android SKDs

1. The first thing is already implemented by us in our landing pages. When the user clicks on an offer on our landing page the url is copied to clipboard with some additional query parameters.
2. When the user opens the app you need to check the last item in the clipboard. If the last item in the clipboard is an url with envoy in the domain name proceed to step 3, otherwise the flow ends here.
3. Save the envoy query parameters(envoy_share_link_hash, envoy_link_uuid) locally
4. Now when you send one of the predefined events related to frontend(Marked with yellow in the table above) please also send those query params. This way you can see how many users got on your platform from envoy

And that’s it 🎉

CSV Exports

This button in the analytics will export all the events tracked with our analytics functionality

The CSV will contain the following columns

share_link_hash	Hash of the link from where the event was triggered
sharer_user_id	ID of the user who created the link
event_name	Name of the event
conversion	Whether or not the event was used for rewards unlocking
timestamp	Time of the event