Get started with the RudderStack 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 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": ""

The corresponding event that generates the above payload via the JavaScript SDK is:"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.

Page fields

Apart from the common fields, the page call accepts the following fields:

nameStringOptionalThe name of the page.
propertiesObjectOptionalIncludes the properties of the page like the url, referrer, etc.
For more information, see the Properties section below.


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.


The page name. This is a reserved property for future use.

pathStringThe path component of the page URL.

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.

titleStringThe page title.

The full URL of the previous page visited by the user.


The querystring component of the page URL.


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.

Questions? Contact us by email or on Slack