Connecting analytics services
Glossary
Event
Description
How it works
Connect analytics to track events related to user actions on your site and payment UI events. Xsolla supports automatic integration with the Google Analytics service, with the ability to receive advanced analytics of site events and the payment UI. In addition, you can connect any other analytics service using Google Tag Manager and receive an extended list of events for your website and the payment UI. You can set up analytics with:
- Google Analytics (automatic integration)
- another analytics service (requires setting up Google Tag Manager)
Xsolla complies with international data protection standards. When integrating third-party analytics services, not all user data may be collected due to GDPR and CCPA regulations.
To lawfully collect data, user consent must be obtained. Users can review data collection terms in the cookie banner. Depending on the user’s region and legislative restrictions, data is collected in one of the following cases:
- The user has agreed to tracking and accepted all cookie files.
- The user has not opted out of tracking.
Analytics collection can also be influenced by:
- Ad blockers that can block analytical systems and hinder tracking.
- Browsers such as Safari, Firefox, and Brave that may block third-party cookie files or restrict tracking by default.
Google Analytics connection
- Create a Google Analytics account with the Google Analytics 4 resource type.
- Get service ID:
- In the sidebar, choose Admin.
- On the Admin tab, choose the account and resource.
- Go to the Data Streams tab.
- Click the data stream.
- Copy Measurement ID.
- In your project in Publisher Account, go to the Storefronts > Websites section.
- Select your site and click Configure.
- Go to the Apps section, and in the Google Analytics block, click Connect.
- In the modal window, specify the analytics service ID and click Connect.
- In the modal window, click Publish.
If site publication is not available, make sure all the required conditions are met:
- There are no empty sections in the builder (marked with a red dot).
- The Licensing Agreement with Xsolla has been signed.
- A section for user authorization has been added to the site.
Registration of custom event parameters
You can use the following custom parameters to refine your analytics events:
event_category— identifies the section or block from which the event was sent.event_label— contains event-specific data, such as item SKU, payment methods, and more.
The event_category and event_label parameters are inherited from Universal Analytics and have been retained for backward compatibility with existing dashboards. In Google Analytics 4, they are passed as custom event parameters and don’t appear in standard reports by default. Register them in Google Analytics 4 to use them when building funnels and custom reports.
To register event parameters:
In the sidebar, choose Admin.
On the Admin tab, go to Custom definition.
Click Create custom definition.
In the Definition name field, enter the name of the parameter you want to see when setting up the event funnel.
Example:
Category.In the drop-down Scope list, choose Event.
In the Description field, enter a description (optional).
In the Event parameter field, enter the parameter name:
event_categoryorevent_label.Click Save.
Connecting other analytics services
- Create an account with your chosen analytics service.
- Create a Google Tag Manager account (GTM account).
- Set up a GTM account for your analytics system:
- Set up tags.
- Set up events and settings.
- Publish changes to GTM.
- In your project in Publisher Account, go to the Storefronts > Websites section.
- In the Sites section, select your site and click Configure.
- Go to the Apps section and in the Google Tag Manager block, click Connect.
- Specify the GTM container ID and click Connect. To find the container ID, use the instruction in the How to get your ID input box.
- Click Connect.
- In the modal window, click Publish.
Site events
Site events reflect user actions on the site’s pages such as button clicks, opening widgets, scrolling sliders, etc. These events consist only of an event name and the custom parameters event_category and event_label.
If you require detailed purchase data, refer to the Ecommerce events section. These events provide full context, including purchase amounts and currencies, item SKU, payment methods, transaction IDs, and etc.
Payment UI events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
open | Paystation_landing | The page name. | Opening the payment UI page. |
close | Paystation_landing | The page name. | Closing the payment UI page. |
share | Paystation_landing | The name of the social network. | Clicking the share button. |
payment_method_name | Paystation_landing | The name of the selected payment method. | Clicking the Pay now button on the payment data entry form. |
choose-widget | Paystation_landing | The name of the payment method widget. | Clicking the payment method widget. |
choose-method | Paystation_landing | Payment method name. | Payment method selection. |
change-status | Paystation_landing | Payment status. Possible values:
| Change of payment status. If the user closes the page or payment UI and the status changes after closing, no event message is sent. |
purchase-success | Paystation_landing | done | Successful payment. Similar to the change-status event, but sent only for the done status. |
Header block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
click-login | Header_landing | – | Clicking the login button. |
open-login | Header_landing | – | Opening the authorization widget when clicking the authorization button. |
open-uid-widget | Header_landing | – | Opening the ID input widget when clicking the authorization button. |
click-buy | Header_landing | Item SKU. | Clicking the buy button. |
click-googleplay | Header_landing | – | Clicking a button with a Google Play link. |
click-appstore | Header_landing | – | Clicking a button with an App Store link. |
click-user-account | Header_landing | – | Clicking the profile button for an authorized user. |
open-menu | Header_landing | – | Opening menu in mobile version of the site. |
logo-click | Header_landing | – | Clicking the header logo. |
change_language | Header_landing | Code of the selected language. | Switching the UI language (with page refresh). |
logout | Header_landing | – | Logout from account. |
User ID input widget events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
close | UID_widget_landing | – | Closing the ID input modal window. |
input | UID_widget_landing | – | Starting to enter a value in the ID input field. |
confirm | UID_widget_landing | – | Clicking the ID input confirmation button. |
click-instruction | UID_widget_landing | – | Clicking the link or icon to show Where to find User ID instructions. |
error | UID_widget_landing | – | Identification error (invalid ID entered). |
success_id | UID_widget_landing | Entered user ID. | Successful identification. |
method-validation-start | UID_widget_landing | – | Starting server-side login validation after user identification. |
authorization-success | UID_widget_landing | – | Successful user authorization. |
authorization-by-social | UID_widget_landing | The name of the social network. | Authorization via social network. |
close-instruction | UID_widget_landing | – | Closing the modal window with Where to find User ID instructions. |
deeplink-click | UID_widget_landing | – | Following a deeplink to log in to the application. |
qr-click | UID_widget_landing | – | Clicking the QR code. |
eye-click | UID_widget_landing | – | Showing/hiding the value in the user ID input field. |
Game packs block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
click-buy | Packs_landing | Item SKU. | Clicking the buy button. |
open-login | Packs_landing | – | Opening the authorization widget when clicking the buy button. |
open-uid-widget | Packs_landing | – | Opening the user ID input widget when clicking the buy button. |
click-googleplay | Packs_landing | – | Clicking a button with a Google Play link. |
click-appstore | Packs_landing | – | Clicking a button with an App Store link. |
Promo slider block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
click-buy | Promo_landing | Item SKU. | Clicking the buy button on the slide. |
open-login | Promo_landing | – | Opening the authorization widget when clicking the buy button on the slide. |
open-uid-widget | Promo_landing | – | Opening the user ID input widget when clicking the buy button on the slide. |
click-googleplay | Promo_landing | – | Clicking a button with a Google Play link on a slide. |
click-appstore | Promo_landing | – | Clicking a button with an App Store link on a slide. |
enter-email | Promo_landing | – | Clicking the email confirmation button when subscribing to the newsletter. |
Store block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
auth | Store_landing_buy_button | – | Opening the authorization modal window after a user clicks the buy button. |
open-ps | Store_landing_buy_button | Item SKU. | Initializing the payment UI after a user clicks the buy button in an item card. |
auth | Store_landing_pop-up | – | Opening the authorization modal window after an unauthorized user clicks the buy button in an item modal window. |
open | Store_landing_pop-up | Item SKU. | Opening the item card modal window. |
open-ps | Store_landing_pop-up | Item SKU. | Initializing the payment UI after an unauthorized user clicks the buy button in an item modal window. |
Call-to-action block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
click-buy | CTA_landing | Item SKU. | Clicking the buy button. |
open-login | CTA_landing | – | Opening the authorization widget when clicking the buy button. |
open-uid-widget | CTA_landing | – | Opening the user ID input widget when clicking the buy button. |
enter-email | CTA_landing | – | Clicking the email confirmation button when subscribing to the newsletter. |
Footer block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
social | Footer_landing | The name of the social network. | Clicking the social network button. |
Offer chain block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
open-auth | Offer_chain_buy_button | Item SKU. | Opening the authorization modal window after a user clicks the buy button. |
open-ps | Offer_chain_buy_button | Item SKU. | Initializing the payment UI after a user clicks the buy button in an item card. |
claim | Offer_chain_buy_button | Item SKU. | An offer was claimed after the user clicks the claim button in an item card. |
open-auth | Offer_chain_pop-up | Item SKU. | Opening the authorization modal window after an unauthorized user clicks the buy button in an item modal window. |
open-ps | Offer_chain_pop-up | Item SKU. | Initializing the payment UI after the user clicks the buy button in an item modal window. |
claim | Offer_chain_pop-up | Item SKU. | An offer was claimed after the user clicks the claim button in an item modal window. |
open | Offer_chain_pop-up | Item SKU. | Opening the item card modal window after the user clicks the card. |
scroll-right | Offer_chain_landing | – | Scroll right by clicking a right arrow in the offer chain cards slider. |
scroll-left | Offer_chain_landing | – | Scroll left by clicking the left arrow in the offer chain cards slider. |
Daily rewards block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
open-auth | Daily_reward_landing | – | Opening the authorization widget or the user ID input widget when clicking the claim button on the step card. |
open-ps | Daily_reward_landing | Item SKU. | Daily reward was claimed. |
expand | Daily_reward_landing | List action. Possible values:
| Clicking button to expand or collapse the list of daily rewards. |
Rewards block events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
load | Rewards_landing | Reward chain type. Possible values: | Loading of the reward system for an authorized user. |
vp-added | Rewards_landing | Reward chain type. Possible values: | Value points are сredited to the user’s balance. |
step-achieved | Rewards_landing | Reward chain type. Possible values: | The user has progressed to a new step in the rewards system |
step-collected | Rewards_landing | Reward chain type. Possible values: | A reward is successfully claimed. |
step-opened | Rewards_landing | Reward chain type. Possible values: | Opening the step modal window after the user clicks the card. |
reward-tab-click | Rewards_landing | Reward chain type. Possible values: | Switching between the reward chains by clicking tabs. |
reward-button-open-auth | Rewards_landing | Reward chain type. Possible values: | Opening authorization widget or the user ID input widget when clicking the claim button on the step card. |
steps-scroll-right | Rewards_landing | Type of the reward chain the user switched to. Possible values: | Scroll right by clicking the right arrow in the steps cards slider. |
steps-scroll-left | Rewards_landing | Reward chain type. Possible values: | Scroll left by clicking the left arrow in the steps cards slider. |
Cart events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
click-cart |
| – | Clicking the cart icon in the header. |
open-cart |
| – | Opening the cart modal window. |
close-cart | Cart_landing | – | Closing the cart modal window. |
change-item-quantity | Cart_landing | Item SKU. | Changing the item quantity in the cart. |
input-code | Cart_landing | – | Applying a promo code in the cart. |
error_code | Cart_landing | Error code (e.g., 9811). | Error applying a promo code. |
delete | Cart_landing | Item SKU. | Deleting an item from the cart. |
checkout | Cart_landing | – | Creating an order and opening the payment UI. |
back-to-store | Cart_landing | – | Returning to the store from an empty cart. |
clear | Cart_landing | – | Clearing the cart (clicking the Remove all button). |
continue | Cart_landing | – | Returning to the store from the cart (clicking the Keep shopping button). |
click-checkout | Cart_landing | – | Clicking the checkout button. |
confirm_code | Cart_landing | – | Confirming promo code entry. |
remove-code | Cart_landing | – | Removing the applied promo code. |
discount-cart | Cart_landing | – | Applying a discount to the entire cart. |
discount-item | Cart_landing | – | Applying a discount to a single item. |
warning-delete | Cart_landing | – | Showing a warning when deleting an item. |
close-warning | Cart_landing | – | Closing the item deletion warning. |
authorization-modal-open-in-cart | Cart_landing | – | Opening the authorization window when the user places an order or applies a promo code. |
Custom action and navigation events
| Event name | Value of the | Value of the | Description |
|---|---|---|---|
click-link | Dynamic category (depends on the block). | – | Following a link or clicking a button with a link in a block. |
click-page | Dynamic category (depends on the block). | – | Navigating to another site page upon clicking a button. |
click-scroll | Dynamic category (depends on the block). | – | Clicking a button to scroll to a specific block. |
click-more-info | Dynamic category (depends on the block). | – | Clicking the Learn more button. |
open-video | Dynamic category (depends on the block). | – | Opening a video in a lightbox. |
click-subscription | Dynamic category (depends on the block). | – | Clicking the button to subscribe to news. |
input-email | Dynamic category (depends on the block). | – | Entering an email in the newsletter subscription form. |
Ecommerce events
The Xsolla payment UI is loaded in a separate iframe with its own domain and analytics. Only payment initialization and completion events are sent from the landing page. Detailed data on the payment process is sent as ecommerce events.
| Event | Description |
|---|---|
open-paystation | Opening the payment UI. Sent during initialization. |
open-{state_name} | Opening the payment UI page. |
open-payment-credit-card | Opening the payment UI for entering card details. |
open-payment-saved-methods | Opening the page with saved payment methods. |
open-payment-payment-methods | Opening the list of all available payment methods when clicking more. |
open-payment-{id} | Opening the page for a specific payment method, where id is the payment method ID. |
open-external-pages | Opening external pages from the payment UI. |
open-status | Opening the payment status page. |
open-status-processing | Opening the payment status page when processing payment (status — processing). Upon completion, the status transitions to success or error. |
open-status-error | Opening the status page upon a payment error (status — error). |
open-status-success | Opening the status page upon a successful payment (status — success). |
choose-payment-widget | Selection of a payment method widget. |
choose-method | Selection of a payment method. |
click-btn-pay | Clicking the Pay now button on the payment data entry form. |
click-btn-return-url | Clicking the return to store button (Back to the game). |
click-additional-btn-return-url | Clicking an additional return to store button. |
create-invoice | Creating a transaction. Transforms into a purchase event with additional purchase parameters (items, amount, currency). |
purchase | Completing a purchase. The event is sent when an invoice is created and contains detailed purchase information, including item costs and taxes. The event is sent only if you have configured the item catalog in Publisher Account. |
change-status | Changing the payment status. Sent with an additional status parameter. |
General event parameters (sent with every event):
| Parameter | Description |
|---|---|
category | Always paystation. |
version | Payment UI version. |
projectId | Project ID. |
projectName | Project name. |
user_id | User ID. |
v1 | User ID (duplicates user_id). |
country | Payment country code. |
external_id | External ID (if available). |
purchase_invoice_id | Purchase invoice ID on the Xsolla’s side. |
pid | Payment method ID. |
total_sum | Total purchase amount including all fees. |
total_sum_currency | Currency of the total purchase amount. |
purchase_sku | Item SKU. |
purchase_sku_digitalContent | Digital content SKU. |
Additional parameters for the purchase event:
| Parameter | Description |
|---|---|
transaction_id | Transaction ID. |
currency | Currency. |
value | Amount excluding taxes. |
items | Array of items with parameters:
|
Found a typo or other text error? Select the text and press Ctrl+Enter.