Site:Frontend:URLParameters
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, and Random.
Sorts can also be done by custom fields.
Example: http://www.example.com/?sort=title
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.
Example: http://www.example.com/?sort=title&order=asc
limit
The limit variable allows you to request only a subset of the entire context. This essentially means you can page through your context so as to not overwhelm the browser with all the possible data in your system.
Example: http://www.example.com/?limit=40
off
The off variable allows you to specify an offset in your paging. This is normally used along with limit.
Example: http://www.example.com/?off=80&limit=40
q
The q variable allows you to search through the page's context results. This search goes through titles, descriptions, and canonical ids.
Example: http://www.example.com/?q=whatismyname
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.
Example: http://www.example.com/?contentId=myfavoritemovie
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. This parameter also filters the results of a content context, by only providing content that belongs to the user or account.
Example: http://www.example.com/?user=myusername
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.
Example: http://www.example.com/?catId=37
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.
Example: http://www.example.com/?tag=funreading
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.
Example: http://www.example.com/?label=staff-favorite
type
The type variable lets you perform additional filtering on content related contexts. Available types include: Videos, Photos, Blogs, News, Products, Inventory, Events, Songs, Albums, and Objects.
Example: http://www.example.com/?type=video
src
The src variable lets you perform additional filtering on video content. Available sources include: Original Videos, Virtual Videos, Live Videos, Everything except Live Videos, Online Now, Offline Now, and Live Archives.
Example: http://www.example.com/?type=video&src=live
assoc
The assoc variable lets you filter content or profiles by a profile association.
Example: http://www.example.com/?assoc=Director
rel
The rel variable lets you filter content or profiles by a content relationship.
Example: http://www.example.com/?rel=has:dvd
year
The year variable lets you filter content by a particular year. This is useful when creating a blog like site which shows various years in the archive menu.
Example: http://www.example.com/?year=2008
month
The month variable lets you filter content by a particular month. This can be used standalone or with the year variable. This is useful when creating a blog like site which shows various years in the archive menu.
Example: http://www.example.com/?year=2008&month=06
hint
The hint variable lets you give hints to the context to perform custom queries. This is normally the result of experimental features and should only be used with guidance by Metrixstream staff.
countrycode, regioncode, city
These variables are used exclusively for the location context.
