Menu
Feedback
Start here
Tutorials


Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Beta
VTEX Data Pipeline Beta
Navigation Data Pipeline
7 min read

The navigation dataset operates with two main tables: pageviews and sessions. A pageview refers to each new page that a user accesses while browsing a store, while a session is the set of all pageviews made by a user in a single visit. Each session remains active until no new pageviews occur for a period of 30 minutes.

The navigation dataset does not capture all types of events that occur during browsing. For example, specific clicks, special events, and interactions with the mini cart are not recorded.

This section includes the following information:

Data characteristics

CharacteristicDescription
Data sourceThe data in this set comes from a script that runs on the store frontend and logs user session information and activity.
AvailabilityNavigation data can be accessed through the Overview dashboard in the VTEX Admin, with a focus on total sessions and the conversion funnel, or also through third-party tools such Google Analytics.
HistoryThe data is retained for two years, starting 2022 for clients who already use the VTEX platform.
Minimum update intervalOne hour.

Data Pipeline only provides data from sessions originating from VTEX storefront solutions: Legacy CMS, Store Framework, and FastStore. VTEX does not have access to sessions originating from third-party marketplaces or proprietary storefronts. Furthermore, storefront customizations may interfere with or even disable the script, resulting in some sessions not being recorded, or in discrepancies in the conversion rate observed in the dashboard. To minimize the impact on store performance, the script is configured to be the last element to load on the page. This means that very brief sessions may not be captured.

Table: sessions

This table only contains closed sessions, whether due to inactivity or because a purchase was completed. It's sorted by session_id, session_end_time, and store_name. Avoid filtering large data ranges by columns that are not part of this sorting strategy. The table fields are described below:

Column nameField typeDescription
batch_idcharacter varying(13)Control ID of data ingestion.
session_idcharacter varying(127)Session UUID, corresponding to the VtexRCSessionIdv7 cookie.
store_namecharacter varying(127)Name of the store that generated the page views for this session.
account_namecharacter varying(127)VTEX account of the store that is generating this session.
economic_group_idcharacter varying(127)Identifier of the economic group used for billing.
economic_group_namecharacter varying(1024)Name of the economic group used for billing.
company_idcharacter varying(127)Company identifier for billing.
company_namecharacter varying(1024)Name of the company for billing.
main_account_namecharacter varying(127)Name of the main VTEX account related to the store generating this session.
os_familycharacter varying(1023)Operating system family, extracted from user_agent.
os_majorcharacter varying(1023)Major operating system version, extracted from user_agent.
os_minorcharacter varying(1023)Minor operating system version, extracted from user_agent.
os_patchcharacter varying(1023)Operating system patch, extracted from user_agent.
os_patch_minorcharacter varying(1023)Minor operating system patch, extracted from user_agent.
device_brandcharacter varying(1023)Device brand, extracted from user_agent.
device_familycharacter varying(1023)Device family, extracted from user_agent.
device_modelcharacter varying(1023)Device model, extracted from user_agent.
browser_familycharacter varying(1023)Browser family, extracted from user_agent.
browser_majorcharacter varying(1023)Major browser version, extracted from user_agent.
browser_minorcharacter varying(1023)Minor browser version, extracted from user_agent.
browser_patchcharacter varying(1023)Browser patch, extracted from user_agent.
user_idcharacter varying(16383)Unique identifier of the buyer, mapped by the VtexRCMacIdv7 cookie.
pageviews_countintegerCount of page views in this session.
views_homeintegerCount of home page views in this session.
views_categoryintegerCount of category page views in this session.
views_departmentintegerCount of department page views in this session.
views_searchintegerCount of search page views in this session.
views_productintegerCount of product page views in this session.
views_checkoutintegerCount of checkout page views in this session.
views_otherintegerCount of views for pages other than product, search, category, department, or checkout in this session.
views_checkout_cartintegerCount of checkout page views at the cart stage.
views_checkout_paymentintegerCount of checkout page views at the payment stage.
views_checkout_shippingintegerCount of checkout page views at the shipping stage.
views_checkout_profileintegerCount of checkout page views at the profile stage.
views_checkout_orderplacedintegerCount of checkout page views at the completed order stage.
views_checkout_emailintegerCount of checkout page views at the email stage.
workspacecharacter varying(16383)VTEX workspace.
user_agentcharacter varying(16383)User-agent string extracted from the request server.
is_first_visitbooleanSpecifies whether this is the user's first visit. It doesn't count for recurring visitors using different browsers.
session_start_timetimestamp without time zoneStart date and time of the session.
entrance_page_urlcharacter varying(16383)URL of the first page view in this session.
entrance_page_typecharacter varying(16383)Page type of the first view in this session.
entrance_page_checkout_stepcharacter varying(16383)Checkout stage of the first page view in this session.
session_end_timetimestamp without time zoneEnd date and time of the session.
exit_page_urlcharacter varying(16383)URL of the last page view in this session.
exit_page_typecharacter varying(16383)Page type of the last view in this session.
exit_page_checkout_stepcharacter varying(16383)Checkout stage of the last page view in this session.

Table: pageviews

Each item in this table corresponds to a page viewed by the buyer, such as homepage, product page, and checkout stage.
A page view is counted after the buyer's browser loads the page. Each page has specific attributes, however, because this table brings everything together in a single schema, many null values will appear. For example, product page attributes are expected to be null when the page view corresponds to a shopping cart stage. The table fields are described below:

Column nameField typeDescription
client_datetimestamp without time zoneDate and time of the page view.
session_idcharacter varying(127)Unique identifier of a session, which maps directly to the VtexRCSessionIdv7 cookie.
page_typecharacter varying(127)Type of page accessed, with predefined values such as 'home', 'category', 'product', among others.
checkout_stepcharacter varying(127)Checkout stage of the page, valid when page_type is 'checkout'.
economic_group_idcharacter varying(127)Identifier of the economic group used for billing.
economic_group_namecharacter varying(1024)Name of the economic group used for billing.
company_idcharacter varying(127)Company identifier for billing.
company_namecharacter varying(1024)Name of the company for billing.
main_account_namecharacter varying(127)Main License Manager account the store is associated to.
account_namecharacter varying(127)License Manager account the store is associated to.
store_namecharacter varying(127)Name of the store that generated the page view event.
urlcharacter varying(16383)Full URL of the page view.
store_hostcharacter varying(127)Hostname extracted from the URL.
page_urlcharacter varying(16383)Clean URL of the page view, without query parameters.
refcharacter varying(16383)URL of the page that referred the buyer to this page.
workspacecharacter varying(127)VTEX workspace, usually 'master'.
workspace_ab_test_idcharacter varying(127)AB test ID extracted from the workspace name.
user_agentcharacter varying(16383)User-agent string extracted from the server side.
os_familycharacter varying(1023)OS family extracted from user_agent.
os_majorcharacter varying(1023)Major OS version extracted from user_agent.
os_minorcharacter varying(1023)Minor OS version extracted from user_agent.
os_patchcharacter varying(1023)OS patch extracted from user_agent.
os_patch_minorcharacter varying(1023)Minor OS patch extracted from user_agent.
device_brandcharacter varying(1023)Device brand extracted from user_agent.
device_familycharacter varying(1023)Device family extracted from user_agent.
device_modelcharacter varying(1023)Device model extracted from user_agent.
browser_familycharacter varying(1023)Browser family extracted from user_agent.
browser_majorcharacter varying(1023)Major browser version extracted from user_agent.
browser_minorcharacter varying(1023)Minor browser version extracted from user_agent.
browser_patchcharacter varying(1023)Browser patch extracted from user_agent.
user_idcharacter varying(127)Unique buyer identifier.
is_first_visitbooleanSpecifies whether this is the user's first visit.
category_idcharacter varying(127)Category identifier.
category_namecharacter varying(16383)Category name.
department_idcharacter varying(127)Department identifier.
department_namecharacter varying(16383)Department name.
product_idcharacter varying(127)Product identifier.
product_reference_idcharacter varying(1024)Product reference.
product_namecharacter varying(16383)Product name.
product_brand_idintegerProduct brand identifier.
product_brand_namecharacter varying(1024)Product brand name.
product_department_idintegerProduct department identifier.
product_department_namecharacter varying(1024)Name of the product department.
product_category_idintegerProduct category identifier.
product_category_namecharacter varying(1024)Name of the product category.
product_list_pricenumeric(22,4)List price of the product.
product_pricenumeric(22,4)Product price.
seller_idcharacter varying(127)Seller identifier.
seller_idscharacter varying(16383)Seller identifiers.
site_search_termcharacter varying(16383)Search term on the website.
site_search_formcharacter varying(16383)Search form on the website.
site_search_categorycharacter varying(127)Search category on the website.
site_search_resultsintegerWebsite search results.
sales_channelcharacter varying(10)Sales channel.
order_form_idcharacter varying(127)Identifier of the order form.
order_form_shippingnumeric(22,4)Shipping cost on the order form.
order_form_totalnumeric(22,4)Total on the order form.
order_form_taxnumeric(22,4)Tax on the order form.
campaign_namecharacter varying(16383)Campaign name.
campaign_sourcecharacter varying(16383)Campaign source.
campaign_mediumcharacter varying(16383)Campaign medium.
internal_campaign_namecharacter varying(16383)Name of the internal campaign.
internal_campaign_partcharacter varying(16383)Part of the internal campaign.
order_form_payment_typecharacter varying(127)Type of payment on the order form.
order_groupcharacter varying(127)Order group.
transaction_idcharacter varying(127)Transaction identifier.
visitor_login_statecharacter varying(16383)Visitor login status.
visitor_typecharacter varying(16383)Visitor type.
visitor_optin_news_letterbooleanSpecifies whether the visitor opted in to the newsletter.
profile_idcharacter varying(127)Profile ID of the buyer received from the VTEX Profile system.
batch_idcharacter varying(13)Control ID of data ingestion.
idcharacter varying(36)UUID generated during data ingestion.
transaction_productssuperProducts in the transaction.
transaction_totalnumeric(22,4)Transaction total.

Analyses with navigation data

Navigation data can be used for the following analyses:

  • Overall conversion rate: Calculate the proportion of sessions that resulted in a purchase in relation to the total number of sessions to assess the overall effectiveness of the website in converting visitors into buyers.
  • Conversion funnel analysis: Group pageviews by funnel stages (home, search, product, cart, checkout) and count how many sessions have passed through each stage, identifying where users give up.
  • Most visited pages: Count the number of pageviews for each type of page (home, category, product) to identify the pages that attract the most attention and optimize them for conversion.
  • User path tracking: Follow the sequence of the pageviews for each session to understand the path taken by the user and discover common navigation patterns.
  • Traffic source: Analyze the reference URL of each session to determine the traffic source and get insight about which marketing channels are most effective.
  • Bounce rate by page type: Identify sessions that end after a single page view and calculate the bounce rate by page type to improve the content or design of these pages.

Correlations with other data

VTEX navigation data has significant interactions with other datasets that enrich user behavior analysis, for example:

  • Interaction with order data: Comparative analysis between navigation and order conversions reveals the impact of user journeys on purchase decisions.
  • Relationship with SKUs: User interaction with product and category pages offers insights into the popularity and effectiveness of product presentation.
  • Marketing data and campaigns: The correlation between navigation and marketing campaigns helps evaluate how efficient campaigns are in attracting traffic and generating conversions.

Discover other Datasets

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Inventory Data Pipeline
« Previous
Payments Data Pipeline
Next »
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback