Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Include Page
Header
Header

100% compatible with Segment

Info

These specs are 100% compatible with http://segment.com specs.

Topics

Table of Contents
none
minLevel1style
maxLevel6
include
outlinefalse
indent
styledefault
excludeTopics
typelist
class
printabletrue

The page call lets you record whenever a user sees a page of your website, along with any optional properties about the page.

...

Beyond the common fields, the page call takes the following fields:

FIELD

REQUIRED?

TYPE

DESCRIPTION

category

optional

String

The category of the page, added to the properties object.
Passed as the first argument in a page call, for example analytics.page("category", "name");

name

optional

String

Name of the page For example, most sites have a “Signup” page that can be useful to tag, so you can see users as they move through your funnel.

properties

optional

Object

Free-form dictionary of properties of the page, like url and referrer

Tracking screen views on users AND accounts!

...

Reserved properties journy.io has standardized:

PROPERTY

TYPE

DESCRIPTION

name

String

Name of the page. Reserved for future use.

path

String

Path portion of the page’s URL. Equivalent to canonical path which defaults to location.pathname from the DOM API.

referrer

String

Previous page’s full URL. Equivalent to document.referrer from the DOM API.

search

String

Query string portion of the page’s URL. Equivalent to location.search from the DOM API.

title

String

Page’s title. Equivalent to document.title from the DOM API.

url

String

Page’s full URL. Segment first looks for the canonical URL. If the canonical URL is not provided, journy.io uses location.href from the DOM API.

keywords

Array [String]

A list/array of keywords describing the page’s content. The keywords would most likely be the same as, or similar to, the keywords you would find in an HTML meta tag for SEO purposes. This property is mainly used by content publishers that rely heavily on pageview tracking. This isn’t automatically collected.

Note: In analytics.js, journy.io automatically sends the following properties: title, path, url, referrer, and search.

Include Page
Footer
Footer