FIELD | TYPE | DESCRIPTION |
---|---|---|
category | 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 | 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 | Object | Free-form dictionary of properties of the page, like url and referrer. See the Properties field docs for a list of reserved property names. |
Example
Here’s a complete example of a page call:Identities
The User ID is a unique identifier for the user performing the actions. Check out the User ID docs for more detail. The Anonymous ID can be any pseudo-unique identifier, for cases where you don’t know who the user is, but you still want to tie them to an event. Check out the Anonymous ID docs for more detail. Note: In our browser and mobile libraries a User ID is automatically added from the state stored by a previous identify call, so you do not need to add it yourself. They will also automatically handle Anonymous IDs under the covers.Properties
Properties are extra pieces of information that describe the page. They can be anything you want. Innkeepr handles properties with semantic meanings in unique ways. For example, Innkeepr always expects path to be a page’s URL path, and referrer to be the previous page’s URL. You should only use reserved properties for their intended meaning. Reserved properties Innkeepr 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. Innkeepr first looks for the canonical URL. If the canonical URL is not provided, Innkeepr 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. Mainly used by content publishers that rely heavily on pageview tracking. Not automatically collected. |