All parameters

All rek.ai parameters

A complete list of the parameters you can add to your recommendations for filtering etc.

Prediction

NameDescription
nrofhitsSet the number of hits to retrieve
addcontentWhether content should be added to the json result

Filter parameters

NameDescription
termWhether a word or phrase must be included in the page title or introduction
subtreeIf only one or more part of ​​the site is to be recommended
maxpathdepthThe maximum depth of the path page has
minpathdepthThe minimum depth the path page has
pagetypeDetermines which type of pages should be recommended
intitleA string that must be included in the title for a hit to be recommended. Used in autocomplete.
domainIf a project has several domains in the same model, the parameter controls a filtering on domain
allowedlangsIf a recommendation should only recommend pages of a certain language.
userootpathIf the recommendation is to be filtered based on part of the current URL-path that the visitor is on.
rootpathlevelIf userootpath is set to true, this parameter controls the number of parts of path that control the filter.
ldjsonfilter.[parameter] = valuePossibility to filter on arbitrary parmater->value combination that exists in your LD+JSON.
excludetreeWhether one or more branches of the site should be excluded from the recommendations
notpagetypeDetermines which type of pages should not be recommended
notdomainIf a project has several domains in the same model, the parameter controls a filtering on domains that should not be displayed
excludechildnodesWhen filtering using userootpath, we can set this flag to true to avoid including direct subpages to the current page.
tagsThe tags you can enter per Question & Answer in the Dashboard can be filtered on the recommendation.

Render

NameDescription
useh1forcontentIf the page's h1 should be used when rendering instead of the page title
titlemaxlengthIf the page's h1 should be used when rendering instead of the page title
headertextA heading that is printed above the recommendations. Ex: “Recommended reading”
headerheadinglevelH-level for the header above the recommendations. If set to 0, no H tag is used
headerfontclassH-tag class for the header
headeridID of the header
renderstyleIf and how should the recommendations be rendered: list, content, advanced, tree or sort
addstripesAdds a class that creates every other color in lists
stripecolorWhat color should the biannual coloring be
hideimageMake sure that the image is not rendered in the function that writes content
listcolsNumber of columns 1,2 or 3. Add data-renderstyle="list" to make it work with the columns.
stylingIf the rendering of the recommendations is to use a CSS framework, the name of the framework can be specified here

Advanced

NameDescription
callbackThe name of a function that will be executed instead of rendering
projectidUnless the default value for the project is to be used
rtSpecifies returntype: default is JSON, svauto = autocomplete for SiteVision
ignorelabelsIf a project uses labels, can skip using these for a specific recommendation.
nrofcontextualhitsWhether a specific number of recommendations should be based on context.