Site:Frontend:URLParameters

From Metrixstream
Revision as of 12:55, 1 October 2011 by MetrixAdmin (Talk | contribs)

Jump to: navigation, search

Contents

Introduction

URL Parameters allow you to manipulate the page via the URL. Listed below are explanations on the internal variables that can be referenced.

hdf

Although this parameter doesn't perform any filtering, it is extremely important to remember because it shows you what hdf keys are available to be referenced, which means it is extremely handy in debugging something within the page.

Example: http://www.example.com/?hdf

page

The page variable directly maps to a particular page within your site.

Example: http://www.example.com/?page=contact_us

sort

The sort variable specifies how your context results should be sorted. Different choices are available depending on the context referenced.

Available sorts include: Release Date, Release Date (#2), Release Date (#3), Event Date, Join Date, Title, Creation Date, Id, Canonical Id, # of Views, # of Comments, # of Favorites, # of Ratings, Summed Rating Score, Average Rating Score, Attendance, Decision Date, Activity, Online Status, then Average Rating, Random

Sorts can also be done by custom fields.

order

The order variable allows you to choose how you want your sorting to appear. This variable has 2 possible values: desc (descending order) and asc (ascending order). Normally this variable is omitted from the URL since it is controlled within the context, but for your convenience it is available to change on the fly.

q

The q variable allows you to search through the page's context results. This search goes through titles, descriptions, and canonical ids.

contentId

The contentId variable allows you to specify which content object you are trying to view. This parameter results in the MS.activeContent portion of the HDF object. The contentId variable can either by the numerical id or the canonical id of the content object.

user

The user variable allows you to lookup either an account profile or a user profile by their username. Usernames are unique across accounts and users. If a username matches an account, then the MS.activeOwner portion of the HDF object will be populated. If a username matches a user, then the MS.activeUser portion of the HDF object will be populated.

catId

The catId variable lets you specify which category you want to use in your filtering. This variable results in the MS.activeCategory portion of the HDF object.

tag

The tag variable lets you specify which tag you want to use in your filtering. This variable results in the MS.activeTag portion of the HDF object.

label

The label variable lets you specify which label you want to use in your filtering. Since labels are considered a security mechanism, only labels whitelisted for a particular page can be referenced via the URL. This variable results in the MS.activeLabel portion of the HDF object.

Personal tools