Tracking and Analytics Tools Integration
The platform supports integration of various tracking and analytic tools, which can monitor the platform dashboard, including all the traffic information, used functionality, and performed actions.
In order to integrate an analytics tool, you can add the following connector’s code and event tracking to the dashboard’s header.html:
|
|
Here, the _onTrackUserEvent function takes one argument ("e"), which is an event object containing the following fields:
- userId – unique identifier of the user who triggered the event
- userGroup – group of the user who triggered the event
- userGroupType – group type (trial, beta, post, billing) of the user who triggered the event
- category – category of the event (mandatory)
- action – action that triggered the event (mandatory)
- label – event label (optional)
- value – event value (optional)
Tip: Check the table in the corresponding section below for the event specifics.
Below, you can check two examples:
- for Google Analytics 4
|
|
- for third party custom analytics service (Matomo Analytics)
|
|
Event Category/Action/Label Values
In the table below you can find all the possible values for the events:
Event Category | Event Action | Event Label | Description |
---|---|---|---|
AppStore | cancel, click-install, success | uid; solution name | installing an application or add-on from the Marketplace |
ConfigManager | read, write, upload | uid; path | actions performed in the Configuration Manager |
Deploy-Archive | default, failed, custom, click | uid; archive file name | deploying the application |
Docker-Redeploy | success, failed | uid | tracked after node redeploy success |
Env-Create | click, basic-success, expert-success, expert-failed | uid | creating a new environment |
Env-Wizard | cost-details-hint | uid; user group; wizard mode | editing environment topology |
FloatMenu-Balancer | run, node-config, node-stat, node-log, node-restart, node-solutions, docker-redeploy, guacamole | uid | using the options of the NGINX-balancer node tool menu |
FloatMenu-Buildnode | build-project-add, node-log, node-config, node-stat, node-solutions, docker-redeploy, guacamole | uid | using the options of the Maven build node tool menu |
FloatMenu-Buildproject | add-project, build-project-run, build-project-run-and-deploy, build-project-edit, build-project-config, build-project-log, build-project-delete | uid | build the project via Maven |
FloatMenu-Buildprojectsroot | build-project-config, build-project-log, build-project-add | uid | build the ROOT project via Maven |
FloatMenu-Cache | node-log, node-config, node-stat, node-restart, node-solutions, docker-redeploy, guacamole | uid | using the options of the Memcached node tool menu |
FloatMenu-Compute | node-config, node-log, run, node-restart, node-stat, node-solutions, add-php-context, docker-redeploy, guacamole | uid | using the options of the application server node tool menu |
FloatMenu-Context | context-open, context-delete, context-vcs-edit, context-vcs-update | uid | managing the context of the deployed project |
FloatMenu-Database | run, node-config, node-log, node-restart, node-stat, node-solutions, docker-redeploy, guacamole | uid | using the options of the database server node tool menu |
FloatMenu-Deployments | deploy-file, deploy-url, deploy-vcs | uid | deploying an application from the archive |
FloatMenu-Env | delete, edit, settings, run, clone, switch | uid | using the options of the environment tool menu |
FloatMenu-Vds | run, node-stat, node-restart, node-log, node-config, node-solutions, docker-redeploy, guacamole | uid | using the options of the VPS node tool menu |
QuotasPricing-Widget | account-cld-cost-tab, account-storage-cost-tab, account-network-cost-tab, account-options-cost-tab, account-quotas-tab, account-software-tab | uid; user group | review pricing information |
Show-Tutorial | maintoolbar | uid; user group | using the tutorial for the beginners |
Tutorial | stop | uid; group or current tip | completing the tutorial or just stopping it |
Upload-Archive | success, cilck, failed | uid; archive name | uploading the archive |
User-Account | maintoolbar | 6672; billing | using account settings |
User-AutoRefill | maintoolbar, add-payment | uid | using the auto-refill option |
User-BillingHistory | trial-menu, maintoolbar | uid; user group | clicking Balance > Billing History button |
User-ChangePassword | maintoolbar | uid; user group | changing the password |
User-CheckGroup | billing, beta, trial | uid | called alongside signing in the dashboard |
User-ConvertAccount | show-trial-menu, pricing-widget, wizard-notice, user-convert-invitation | uid | requesting account upgrade |
User-HosterPricing | trial-menu | uid; source menu | reviewing hoster pricing |
User-HosterSupport | mmaintoolbar, convert-refill, refill, account-limits | uid; user group | clicking Help > Contact Support button |
User-JelasticCommunity | maintoolbar | uid; user group | navigating to the community |
User-JelasticDocs | maintoolbar, wizard | uid; user group | navigating to the documentation from the dashboard |
User-JelasticVideos | maintoolbar | uid; user group | clicking Help > Video button |
User-QuotasPricing | maintoolbar, trial-menu, wizard | uid; user group | clicking Balance > Quotas & Pricing button |
User-RefillAccount | balance-btn, submit-click, add-success, declined, refresh-btn, confirm-yes, msg-suspended-account | uid; new | clicking on the Refresh balance, Refill Balance buttons and refilling through message about account has been suspended |
User-Search | search requests | uid | using How do I…? search box |
User-Settings | maintoolbar | uid; billing | using user settings |
User-Signin | success, failed | uid or guest | signing in to the dashboard (both successful and failed) |
User-Signup | click, by-link, success | guest | signing up |
User-Terms | convert-dlg | uid | viewing terms of service |
User-ViewInvoices | maintoolbar | uid | using the View Invoices button |