Analytics
- Pawel Mastalerz
Table of Contents
- 1 Table of Contents
- 2 Global GTM tag
- 3 Page titles
- 4 Events
- 5 SendInBlue Analytics
- 5.1 High-level Requirements
- 5.2 API Spec
- 5.2.1 Server and credentials
- 5.2.2 Request
- 5.2.2.1 Body Example
- 5.2.3 Response
Global GTM tag
The following tags should exist on every page, except Admin pages. No need to customize based on environment (e.g. Test, Prod). Same tag is to be shown.
Head
refid is a variable which indicates:
For Partner of type Partner insert Partner Functionality | Referrer Profiles ID
For Partner of type Affiliate insert “affiliate”
<script>
window.dataLayer = window.dataLayer || [];
</script>
<script>
dataLayer.push({event: "userData", refid: "uniqueone"})
</script>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-KZHJFJH');</script>
<!-- End Google Tag Manager -->Body
Immediately after <body> tag.
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KZHJFJH"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->Page titles
Page views are triggered by change in url, therefore every page needs to have a unique url. URLs in red need to be updated, as they are duplicates now.
URL | Spec reference | Page Title |
|---|---|---|
/ (unauthenticated) | FIO App - Home | |
/myfio | FIO App - My FIO | |
/create-account | FIO App - Create Account | |
/create-account-pin | FIO App - Create Account Pin | |
/create-account-confirm | FIO App - Create Account Confirm | |
/create-account-confirmation | FIO App - Create Account Confirmation | |
/create-account-secret-questions | FIO App - Create Account Secret Questions | |
/create-account-secret-questions-skip | FIO App - Create Account Secret Questions Skip | |
/create-account-secret-answers | FIO App - Create Account Secret Answers | |
/email-confirm-gate | FIO App - Confirm email | |
/signin | FIO App - Sign in | |
/fio-crypto-handles-selection | FIO App - Crypto Handle Registration | |
/fio-domains-selection | FIO App - Domain Registration | |
/cart | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Cart | FIO App - Shopping Cart |
/checkout | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Pay-with-FIO https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Pay-with-Stripe | FIO App - Checkout |
/purchase | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Pay-with-FIO-Confirmation | FIO App - Purchase Confirmation |
/tokens | FIO Apps - Wallets | |
/import | FIO App - Import FIO Wallet | |
/fio-wallet | FIO App - Wallet Transactions | |
/fio-wallet-details | FIO App - Wallet Details | |
/stake | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/451477688 | FIO App - Stake FIO Tokens |
/unstake | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/451477688 | FIO App - Unstake FIO Tokens |
/send | FIO App - Send FIO Tokens | |
/send-confirmation | FIO App - Send FIO Tokens Confirmation | |
/new-request | FIO App - FIO Request | |
/new-request-confirmation | FIO App - FIO Request Confirmation | |
/reject-fio-request | FIO App - Reject FIO Request | |
/reject-fio-request-confirmation | FIO App - Reject FIO Request Confirmation | |
/payment-details | FIO App - Send FIO Data | |
/payment-details-confirmation | FIO App - Send FIO Data Confirmation | |
/fio-domains | FIO App - Domains | |
/fio-domain-settings | FIO App - Domain Settings | |
/fio-domain-renew | Domain renewal | FIO App - Renew Domain |
/fio-domain-renew-confirmation | Domain renewal confirmation | FIO App - Renew Domain Confirmation |
/fio-domain-status-change | FIO App - Domain Status Change | |
/fio-domain-status-change-confirmation | FIO App - Domain Status Change Confirmation | |
/fio-domain-ownership | FIO App - Domain Ownership Transfer | |
/fio-domain-ownership-confirmation | FIO App - Domain Ownership Transfer Confirmation | |
/fio-crypto-handles | FIO App - Crypto Handles | |
/fio-crypto-handle-settings | FIO App - Crypto Handle Settings | |
/add-bundles | Add bundles | FIO App - Add Bundles |
/add-bundles-confirmation | Add bundles confirmation | FIO App - Add Bundles Confirmation |
/fio-crypto-handle-ownership | FIO App - Crypto Handle Ownership Transfer | |
/fio-crypto-handle-ownership-confirmation | FIO App - Crypto Handle Ownership Transfer Confirmation | |
/nft-signatures | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/299630593/NFT+Signatures#NFT-Signatures-List | FIO App - NFT Signatures |
/sign-nft | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/299630593/NFT+Signatures#Sign-NFT.1 | FIO App - Sign NFT |
/sign-nft-confirmation | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/299630593/NFT+Signatures#Sign-NFT-Details | FIO App - Sign NFT Confirmation |
/link-token-list | FIO App - Linked Token List | |
/add-token | FIO App - Link Token | |
/add-token-confirmation | FIO App - Link Token Confirmation | |
/fio-domain | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/510328833 | FIO App - Domain |
/orders | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/503054375/My+Orders#My-Orders | FIO App - Orders |
/order-details | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/503054375/My+Orders#Order-Details | FIO App - Order Details |
/order-invoice | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/503054375/My+Orders#Order-Invoice-PDF | FIO App - Order Invoice |
/settings | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/310608242 | FIO App - Settings |
/ref/partnername | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/490307680/Partner+Functionality#Landing-Page | FIO App - partnername |
/wrap-tokens | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/479854635/Token+Wrapping#Wrap-FIO-Tokens | FIO App - Wrap FIO Tokens |
/wrap-tokens-confirmation | FIO App - Wrap FIO Tokens Confirmation | |
/unwrap-tokens | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/493846529/Token+Unwrapping#Unwrap-FIO-Tokens | FIO App - Unwrap FIO Tokens |
/unwrap-tokens-confirmation | FIO App - Unwrap FIO Tokens Confirmation | |
/wrap-domain | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/490635272/Domain+Wrapping#Wrap-FIO-Domain | FIO App - Wrap FIO Domain |
/wrap-domain-confirmation | FIO App - Wrap FIO Domain Confirmation | |
/unwrap | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/493846529 | FIO App - Unwrap |
/unwrap-domain | FIO App - Unwrap FIO Domain | |
/unwrap-domain-confirmation | FIO App - Unwrap FIO Domain Confirmation | |
/privacy-policy | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/310575257 | FIO App - Privacy Policy |
/terms-of-service | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/340623377 | FIO App - Terms of Service |
/reset-password | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/151879691/Security#Forgot-Password | FIO App - Reset Password |
/404 | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/513835009 | FIO App - Not Found |
/cookie-notice | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/517570597 | FIO App - Cookie Notice |
/error |
| FIO App - Error |
/nft-validation |
| FIO App - Validate NFT Signature |
/affiliate-program | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/552042499 | FIO App - Affiliate Program |
/affiliate-program-enabled | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/552042499/Affiliate+Program#Enabled-view | FIO App - Affiliate Program Enabled |
/fio-crypto-handles-custom | FIO App - Crypto Handle Registration on Custom Domain | |
/unavailable | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/513835009/Error+Pages#Outage-Page | FIO App - Unavailable |
/twitter-handle | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/646184971 | Your Twitter Handle Can Now Receive Crypto |
/ | Using fio.id domain https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/671055873/FCH+Profile#Profile-Look-up | FIO Handle Look-up |
/example@domain | Using fio.id domain https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/671055873/FCH+Profile#Profile---Payments | FIO Handle - example@domain |
/metamask | https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/818479110 | FIO App - MetaMask |
Events
When fires | Event name | Parameters |
|---|---|---|
User creates account |
|
|
User logs in |
|
|
User searches for FCH or Domain or both https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/255624148 |
|
|
User adds item to cart https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Cart |
|
|
User removes item from cart https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Cart |
| Same as Add item to cart |
User clicks Checkout Now (or Complete Transaction) or Cart icon in main navigation https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Cart |
| Same as Add item to cart |
Price updated in cart https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Price-Change |
|
|
User clicks Purchase Now or Pay on checkout page |
| Same as Add item to cart |
Shopping cart is purchased https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Pay-with-FIO-Confirmation |
| Same as Add item to cart plus:
|
Partial purchase error https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Pay-with-FIO-Confirmation |
|
|
Complete purchase error https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/500793345/Checkout#Pay-with-FIO-Confirmation |
|
|
Cart is emptied due to inactivity |
|
|
User creates new FIO wallet |
|
|
User stakes FIO tokens https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/451477688 |
|
|
User unstakes FIO tokens https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/451477688 |
|
|
User sends FIO Tokens |
|
|
User sends new FIO Request |
|
|
User sends FIO Data |
|
|
User rejects FIO Request |
|
|
Users flips domain status |
|
|
Users transfers domain ownership |
|
|
Users transfers FCH ownership |
|
|
User signs NFT https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/299630593/NFT+Signatures#Sign-NFT.1 |
|
|
Users links token to FCH |
|
|
User enables 2FA |
|
|
User sets up recovery |
|
|
User encounters chain error on any transaction, except purchase |
|
|
User validates NFT on https://dashboard.fioprotocol.io/nft-validation |
|
|
User wraps tokens |
|
|
User wraps domain |
|
|
User unwraps tokens |
|
|
User unwraps domain |
|
|
User enables affiliate program |
|
|
SendInBlue Analytics
High-level Requirements
Anytime the above event occurs and the user is known (logged in) and has opted in to receiving marketing emails, the server needs to send an event notification to SendInBlue:
If initial opt-in flag (set by user during registration) is not stored on the server, send the request for every user, but expect 404 error to be returned if user has not opted in and is not in SendInBlue db.
There is a way to also send events via js: https://developers.sendinblue.com/docs/gettings-started-with-sendinblue-tracker , but I believe the API method better matches what was already developed for Mailchimp
API Spec
Server and credentials
See https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/96665686/Emails#Settings
Request
Variable | Type | Value |
|---|---|---|
| User’s email address | |
event | Body | Event name as above |
Body Example
{
"email":"bob@gmail.com",
"event":"sign_up"
}Response
Ignore response