Page

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 method in its snippet just after the rudderanalytics.load method.

Sample payload

Here is a sample payload of a page call after removing the common fields:

{
  "type": "page",
  "name": "Home",
  "properties": {
    "title": "Home | RudderStack",
    "url": "http://www.rudderstack.com"
  }
}

The corresponding event that generates the above payload via the JavaScript SDK is:

rudderanalytics.page("Home")

The JavaScript SDK automatically gathers the page title and url and passes them into the event payload.

However, note that the HTTP API or the server-side SDKs do not automatically capture these properties.

Send a sample page call

Use RudderStack’s Event Playground app to send sample events to RudderStack and test the data flow without any instrumentation.

Click Send to see the API call in the Network tab of your browser’s developer tools.

To send test events to your account:

1. Sign in to RudderStack dashboard. Note the data plane URLThe data plane URL is the location where events are routed and sent to the RudderStack backend for processing. You can find this URL in the home page of your RudderStack dashboard. at the top of the default Connections page.
2. Set up a source and note its write keyThe write key (or source write key) is a unique identifier for your source. RudderStack uses this key to send events from a source to the specified destination. .

3. Click Use My Account in the Event Playground app and specify the write key and data plane URL.
4. Click Save.
5. [Optional] Edit Page Category, Page Name or properties.
6. Click Send to my account.
7. To verify the data flow, go to the Live Events viewer of your source.

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	Includes the properties of the page like the url, referrer, etc. For more information, see the Properties section below.

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.

---

Was this page helpful?    Yes No

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Questions? Contact us by email or on Slack

• Previous
• Next