Endeca URL Parameter Reference

This appendix provides a reference to the Endeca Presentation API’s URL-based syntax for navigation, record, aggregated record, and dimension search queries.

About the Endeca URL query syntax
The Endeca query syntax defines how the client browser communicates with the Presentation API.
N (Navigation)
The N parameter sets the navigation field for a query.
Nao (Aggregated Record Offset)
The Nao parameter sets the navigation aggregated record list offset.
Ndr (Disabled Refinements)
The Ndr parameter lets you display disabled refinements.
Ne (Exposed Refinements)
The Ne parameter sets the dimension navigation refinements that will be exposed.
Nf (Range Filter)
The Nf parameter sets the range filters for the navigation query.
Nmpt (Merchandising Preview Time)
The Nmpt parameter sets a preview time for the application.
Nmrf (Merchandising Rule Filter)
The Nmrf parameter sets a dynamic business rule filter for the navigation query.
No (Record Offset)
The No parameter sets the navigation record list offset.
Np (Records per Aggregated Record)
The Np parameter sets the maximum number of records to be returned in each aggregated record.
Nr (Record Filter)
The Nr parameter sets a record filter on a navigation query.
Nrc (Dynamic Refinement Ranking)
The Nrc parameter sets a dynamic refinement configuration for the navigation query.
Nrcs (Dimension Value Stratification)
The Nrcs parameter sets the list of stratified dimension values for use during refinement ranking by the MDEX Engine.
Nrk (Relevance Ranking Key)
The Nrk parameter sets the search interface to be used when using relevance ranking in a record search.
Nrm (Relevance Ranking Match Mode)
The Nrm parameter sets the relevance ranking match mode to be used to rank the results of the record search.
Nrr (Relevance Ranking Strategy)
The Nrr parameter sets the relevance ranking strategy to be used to rank the results of the record search.
Nrs (Endeca Query Language Filter)
The Nrs parameter sets an EQL record filter on a navigation query.
Nrt (Relevance Ranking Terms)
The Nrt parameter sets the terms by which the relevance ranking module will order the results of the record search.
Ns (Sort Key)
The Ns parameter sets the list of keys that will be used to sort records.
Nso (Sort Order)
The Nso parameter sets the sort order for the record list of the navigation object.
Ntk (Record Search Key)
The Ntk parameter sets which dimension, property, or search interface will be evaluated when searching.
Ntpc (Compute Phrasings)
The Ntpc parameter sets whether the MDEX Engine computes alternative phrasings for the current query.
Ntpr (Rewrite Query with an Alternative Phrasing)
The Ntpc parameter sets whether the MDEX Engine uses one of the alternative phrasings it has computed.
Ntt (Record Search Terms)
The Ntt parameter sets the actual terms of a record search for a navigation query.
Ntx (Record Search Mode)
The Ntx parameter sets the options for record search in the navigation query.
Nty (Did You Mean)
The Nty parameter sets the Did You Mean feature for record search in the navigation query.
Nu (Rollup Key)
The Nu parameter sets the rollup key for aggregated records.
R (Record)
The R parameter sets the ID of the record to be queried for.
A (Aggregated Record)
The A parameter sets the ID of an aggregated record to be queried for.
Af (Aggregated Record Range Filter)
The Af parameter sets the aggregated record range filters for the navigation query..
An (Aggregated Record Descriptors)
The An parameter sets the navigation values which the aggregated record will be aggregated in relation to.
Ar (Aggregated Record Filter)
The An parameter sets the aggregated record navigation record filter.
Ars (Aggregated EQL Filter)
The Ars parameter sets an aggregated record EQL filter.
As (Aggregated Record Sort Key)
The As parameter sets the list of keys that will be used to sort representative records in an aggregated record details query.
Au (Aggregated Record Rollup Key)
The Au parameter sets the rollup key for aggregated records.
D (Dimension Search)
The D parameter sets the dimension search query terms.
Df (Dimension Search Range Filter)
The Df parameter sets the navigation range filters that restrict the dimension search.
Di (Search Dimension)
The Di parameter sets the dimensions which the dimension search can search from.
Dk (Dimension Search Rank)
The Dk parameter sets how the dimension search results are sorted.
Dn (Dimension Search Scope)
The Dn parameter sets a navigation state that reduces the scope of a dimension value search.
Do (Search Result Offset)
The Do parameter sets the dimension search results offset.
Dp (Dimension Value Count)
The Dp parameter sets the number of dimension value matches to return per dimension.
Dr (Dimension Search Filter)
The Dr parameter sets the record filter for the dimension search navigation query.
Drs (Dimension Search EQL Filter)
The Drs parameter sets the dimension search EQL filter.
Dx (Dimension Search Options)
The Dx parameter sets the option set that dimension search will use.