Page
Detailed technical description of the Page API call.
The page
call lets you record your website's page views with any additional relevant information about the viewed page. Many destinations require the page
events to be called at least once every page load.
The RudderStack JavaScript SDK includes a page
call in its snippet just after the rudderanalytics.load
method.
Sample payload
A sample payload of a page
call with most of the Common Fields removed is as shown:
The corresponding event that generates the above payload via the JavaScript SDK is as shown:
The SDK automatically gathers the page name
and url
and passes them into the event payload.
Page fields
Apart from the Common Fields, the page
call accepts the following fields:
Field
Type
Presence
Description
name
String
Optional
The name of the page.
properties
Object
Optional
Properties
Properties are additional information that describe the viewed page.
RudderStack has reserved some standard properties listed in the following table and handles them in a special manner. For instance, path
should always be the URL path of the page and referrer
should be the URL of the previously viewed page.
Property
Type
Description
name
String
The page name. This is a reserved property for future use.
path
String
The path component of the page URL.
url
String
Full page URL. RudderStack first looks for the canonical URL. If it is not present, RudderStack uses the location.href
component from the DOM API.
title
String
The page title.
referrer
String
The full URL of the previous page visited by the user.
search
String
The querystring component of the page URL.
keywords
Array
A list or array of keywords describing the page. These keywords are similar to the keywords used for SEO purposes. This property is not automatically collected.
Contact us
For queries on any of the sections covered in this guide, you can contact us or start a conversation in our Slack community.
Last updated
Was this helpful?