If this API is not enabled for your account, contact your MoEngage Customer Success Manager (CSM) or the Support team to request enablement.
Endpoints
The Recommendation API is a collection of the following endpoints:- Fetch All Recommendations: Lists the recommendations in your workspace, with pagination and status filters.
- Fetch Recommendation Details: Fetches configuration details, status, and logic.
- Fetch Recommendation Results: Fetches personalized items for a user.
FAQs
General Recommendation Questions
How do I find my Recommendation ID?
How do I find my Recommendation ID?
The
recommendation_id is a unique identifier generated when you create a recommendation in the MoEngage Recommendation module. You can find this ID on the individual recommendation’s overview page in the MoEngage Dashboard, or by calling Fetch All Recommendations.Why does an archived recommendation return 400 instead of 404?
Why does an archived recommendation return 400 instead of 404?
Fetch Recommendation Details and Fetch Recommendation Results both return
400 for any recommendation_id they cannot serve. A recommendation that was archived and a recommendation that was never created both return 400. Check the recommendation_id and the recommendation’s status in the MoEngage dashboard.Why should I use the 'include_fields' parameter?
Why should I use the 'include_fields' parameter?
By default, the API returns all attributes associated with an item in the catalog. For catalogs with many attributes, this can significantly increase response size and latency. Specifying only the fields you need (e.g.,
["title", "price", "image_link"]) improves performance.Fetch Results
When is the item_id mandatory in the request body?
When is the item_id mandatory in the request body?
The
item_id acts as an anchor for collaborative filtering models. It is mandatory when the RECOMMENDATION-TYPE is set to similar_item, frequently_viewed_together, or frequently_bought_together.Can I fetch results for a user who doesn't exist in MoEngage yet?
Can I fetch results for a user who doesn't exist in MoEngage yet?
The API requires a valid
user_id. If the user is unknown or hasn’t had any interactions recorded, the recommendation engine may return default items (like trending items) or an empty list depending on your “fallback” settings in the dashboard.What happens if the payload size exceeds 1MB?
What happens if the payload size exceeds 1MB?
The API will return a
413 Request Entity Too Large error. This usually happens if the include_fields list is excessively long or if a very high number of items are requested (if applicable).