Query Parameters Quick Reference

Top level

query  
startIndex default=0
pageSize default=0
exactMatchesOnly default=false
items optional
notItems optional
minRelevance optional
maxRelevance optional
criteria optional
groupBy optional
sortBy optional
drillDown optional
renderParameters optional
exactRelevance optional
minRelevance optional
maxRelevance optional
values optional
properties optional
highlighting optional
explain optional

Criteria

criteria tree mutex ordered integer double time
dimension required required required required required required
weight default=1.0 default=1.0 default=1.0 default=1.0 default=1.0 default=1.0
cull default=false default=true default=true default=true default=true default=true
id optional optional optional      
notId optional optional optional      
value optional optional optional optional optional optional
notValue optional optional optional      
max       optional optional optional
maxInclusive       default=true default=true default=true
min       optional optional optional
minInclusive       default=true default=true default=true
latitude            
longitude            
zipcode            
exactDistance       optional optional optional
normalDistance       optional optional optional
cullDistance       optional optional optional
topN            
exactMatch optional optional optional optional optional optional
nullExactMatch optional optional optional optional optional optional
nullRelevance optional optional optional optional optional optional
minRelevance            
maxRelevance            
searchStyle            
random            
seed            
minStartsWithLength            
didYouMean            
criteria geoloc keyword text groupBy builtin
dimension required required required required  
weight default=1.0 default=1.0 default=1.0    
cull default=true default=false default=false    
id          
notId          
value   optional optional    
notValue          
max          
maxInclusive          
min          
minInclusive          
latitude optional        
longitude optional        
zipcode optional        
exactDistance optional        
normalDistance          
cullDistance          
topN       optional  
exactMatch optional optional optional    
nullExactMatch optional optional optional    
nullRelevance optional optional optional    
minRelevance         optional
maxRelevance         optional
searchStyle   optional optional    
random         required
seed         optional
minStartsWithLength     optional    
didYouMean     dimension    

DrillDown

drillDown  
dimension required
ids optional
depth default=0
isolated default=true

SortBy

sortBy exactMatch relevance id random
builtin required required required  
dimension        
reverse default=false default=false default=false  
latitude        
longitude        
zipcode        
reverse        
seed       optional
minRelevance        
maxRelevance        

Supported dimension types

sortBy integer double time geoloc keyword
builtin          
dimension required required required required required
reverse default=false default=false default=false default=false default=false
latitude       required  
longitude       required  
zipcode       optional  
seed          
minRelevance          
maxRelevance          

Highlighting

highlighting  
fragmentType default=none
maxFragments default=10
delimiter default=”...”
template default=[“<b>”,”</b>”]
fragmentSize default=100
merge default=properties

GroupBy

groupBy  
dimension required
groups  
notGroups  
topN default=0
properties  
highlighting  
indexValues  
legacyGroupBy default=true