Skip to main content
POST
Fetch Recommendation Results

​
Rate Limit

You can make 10,000 requests per minute.

Authorizations

​
Authorization
string
header
required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

For more information on authentication and getting your credentials, refer here.

Headers

​
MOE-APPKEY
string
required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

​
RECOMMENDATION-TYPE
enum<string>
required

It represents the type of recommendations from which the results are fetched.

Available options:
user_action,
item_attribute,
catalog_alert,
similar_item,
frequently_viewed_together,
frequently_bought_together,
trending_item,
user_personalization

Path Parameters

​
recommendation_id
string
required

This parameter indicates the unique identifier associated with the recommendation created in the recommendation module.

You can obtain the recommendation_id from the recommendation you created on the recommendation page.

Body

application/json
​
user_id
string
required

A user ID is a unique identifier that represents a user. You can obtain the user_id from the user info page. For more information, refer to User Identity Management.

​
item_id
string | null

An item_id is a unique identifier assigned to each item in the catalog.

If the RECOMMENDATION-TYPE is any of the similar_item, frequently_viewed_together, or frequently_bought_together, you must provide the item_id.

This item_id acts as the anchor to serve recommended items based on the RECOMMENDATION-TYPE.

We expect the user's most recently interacted item_id to serve contextually recommended items.

​
include_fields
string[] | null

You can define the attributes of items you require from the catalog in the recommendation response. For example, title, price, link, image_link, and so on.

If you don't define any attributes, the response includes every item attribute in the catalog. This increases the response size in proportion to the number of attributes in your catalog. Specify only the attributes you need.

Example:

Response

Indicates that the request is successful and the recommended items are fetched.

​
items
object[]