All rek.ai parameters
A complete list of the parameters you can add to your recommendations for filtering etc.
Prediction
| Name | Description |
|---|---|
| nrofhits | Set the number of hits to retrieve |
| addcontent | Whether content should be added to the json result |
Filter parameters
| Name | Description |
|---|---|
| term | Whether a word or phrase must be included in the page title or introduction |
| subtree | If only one or more part of the site is to be recommended |
| maxpathdepth | The maximum depth of the path page has |
| minpathdepth | The minimum depth the path page has |
| pagetype | Determines which type of pages should be recommended |
| intitle | A string that must be included in the title for a hit to be recommended. Used in autocomplete. |
| domain | If a project has several domains in the same model, the parameter controls a filtering on domain |
| allowedlangs | If a recommendation should only recommend pages of a certain language. |
| userootpath | If the recommendation is to be filtered based on part of the current URL-path that the visitor is on. |
| rootpathlevel | If userootpath is set to true, this parameter controls the number of parts of path that control the filter. |
| ldjsonfilter.[parameter] = value | Possibility to filter on arbitrary parmater->value combination that exists in your LD+JSON. |
| excludetree | Whether one or more branches of the site should be excluded from the recommendations |
| notpagetype | Determines which type of pages should not be recommended |
| notdomain | If a project has several domains in the same model, the parameter controls a filtering on domains that should not be displayed |
| excludechildnodes | When filtering using userootpath, we can set this flag to true to avoid including direct subpages to the current page. |
| tags | The tags you can enter per Question & Answer in the Dashboard can be filtered on the recommendation. |
Render
| Name | Description |
|---|---|
| useh1forcontent | If the page's h1 should be used when rendering instead of the page title |
| titlemaxlength | If the page's h1 should be used when rendering instead of the page title |
| headertext | A heading that is printed above the recommendations. Ex: “Recommended reading” |
| headerheadinglevel | H-level for the header above the recommendations. If set to 0, no H tag is used |
| headerfontclass | H-tag class for the header |
| headerid | ID of the header |
| renderstyle | If and how should the recommendations be rendered: list, content, advanced, tree or sort |
| addstripes | Adds a class that creates every other color in lists |
| stripecolor | What color should the biannual coloring be |
| hideimage | Make sure that the image is not rendered in the function that writes content |
| listcols | Number of columns 1,2 or 3. Add data-renderstyle="list" to make it work with the columns. |
| styling | If the rendering of the recommendations is to use a CSS framework, the name of the framework can be specified here |
Advanced
| Name | Description |
|---|---|
| callback | The name of a function that will be executed instead of rendering |
| projectid | Unless the default value for the project is to be used |
| rt | Specifies returntype: default is JSON, svauto = autocomplete for SiteVision |
| ignorelabels | If a project uses labels, can skip using these for a specific recommendation. |
| nrofcontextualhits | Whether a specific number of recommendations should be based on context. |