Contextualize API Input Parameter Glossary

Created by Pedro Ondiviela · last update June 5, 2020

Parameters Mandatory for Some Endpoints

Parameter Description Data Type Endpoints
user Identifier that represents an unique user along the client String User, User - Products, User - Preferences, User and Query
query Search term that user did String User, User - Products, Query, Query - Attributes, Query - Products, User and Query
lang Language of the query String Query, Query - Attributes, Query - Products, User and Query , Category, Category - Preview
pid Search category scores for this product. Is required to send one at least Integer Category

Purely Optional Parameters

Parameter Description Data Type Default Endpoints
rows (attributes) Number of values of each field Integer 1 Query - Attributes,
rows (products) Number of products to return Integer 5 Query - Products
preferences.rows Number of user values of each field Integer 1 User, User and Query
last_products.rows Number of user products to return Integer 5 User, User and Query
session.preferences.rows Number of session values of each field Integer 1 User, User and Query
session.last_products.rows Number of session products to return Integer 5 User, User and Query
attributes.rows Number of values of each field Integer 1 Query, User and Query
products.rows Number of products to return Integer 5 Query, User and Query
events.min Minimum number of events required to return a field or product. Integer client configuration / 10 ( in Query Context - Attributes: client configuration / 25) Query, Query - Attributes, Query - Products, User and Query
userAttributes User attributes to get segmentation data. Format example: userAttributes= gender:male,size:M String   Query, Query - Attributes, Query - Products, User and Query
maxTries Max tries to do segmentation intents Integer client configuration / 3 Query, Query - Attributes, Query - Products, User and Query

Category Context Preview Parameters

Parameter Description Data Type Mandatory Default
categoryEqualize Custom equalize to obtain products scores related to Object Yes  
categoryEqualizeEvents Events weights to affect scores Object Yes  
categoryId CategoryId to get the product scores Integer Yes  
lang Language of the category to request String No There is a default lang in service configuration
field Field name to get value from the products in the preview Object No {“eb_name”, “eb_image”}
maxProducts Maximum of products in the output result (max value: 100) Integer No 50