curl --request GET \
--url https://api-{dc}.moengage.com/v1/recommendations \
--header 'Authorization: Basic <encoded-value>' \
--header 'MOE-APPKEY: <moe-appkey>'{
"items": [
{
"id": "<string>",
"db_name": "<string>",
"recommendation_type": "<string>",
"name": "<string>",
"description": "<string>",
"catalog": "<string>",
"status": "Active",
"created_time": "2023-11-07T05:31:56Z",
"updated_time": "2023-11-07T05:31:56Z",
"recom_execution_id": "<string>",
"next_run_time": "2023-11-07T05:31:56Z",
"all_user_actions": true,
"include_filters": {
"filters": [
{
"executed": true,
"filter_type": "product_filter",
"operator_fe": "exists",
"name": "product_id",
"data_type": "string",
"operator": "exists",
"value": "<string>",
"negate": true,
"case_sensitive": true,
"hasError": true
}
],
"filter_operator": "and"
},
"exclude_filters": {
"filters": [
{
"executed": true,
"filter_type": "product_filter",
"operator_fe": "exists",
"name": "product_id",
"data_type": "string",
"operator": "exists",
"value": "<string>",
"negate": true,
"case_sensitive": true,
"hasError": true
}
],
"filter_operator": "and"
},
"custom_settings": {
"item_filters": {
"user_actions": {}
}
},
"sort": {
"data_type": "double",
"param_type": "product_attribute",
"param": "price",
"direction": "1"
},
"trend": {
"type": "most_purchased_items",
"in_the_last": "7_days"
},
"catalog_watch_setting": {
"catalog_attribute": "price",
"operator": "LESS_THAN",
"value": 500,
"type": "absolute",
"compare_to": "previous_value"
},
"trigger_event": false,
"business_event": null
}
]
}Fetch All Recommendations
This API retrieves the list of recommendations configured in your workspace, along with the metadata of each recommendation. The results are sorted by the last updated time, with the most recently updated recommendation first.
Use this API to look up the recommendation_id of a recommendation, which you need for the Fetch Recommendation Details and Fetch Recommendation Results APIs.
The response does not include a total count of recommendations. You have reached the last page when the items array contains fewer recommendations than the size you requested, or when it is empty.
curl --request GET \
--url https://api-{dc}.moengage.com/v1/recommendations \
--header 'Authorization: Basic <encoded-value>' \
--header 'MOE-APPKEY: <moe-appkey>'{
"items": [
{
"id": "<string>",
"db_name": "<string>",
"recommendation_type": "<string>",
"name": "<string>",
"description": "<string>",
"catalog": "<string>",
"status": "Active",
"created_time": "2023-11-07T05:31:56Z",
"updated_time": "2023-11-07T05:31:56Z",
"recom_execution_id": "<string>",
"next_run_time": "2023-11-07T05:31:56Z",
"all_user_actions": true,
"include_filters": {
"filters": [
{
"executed": true,
"filter_type": "product_filter",
"operator_fe": "exists",
"name": "product_id",
"data_type": "string",
"operator": "exists",
"value": "<string>",
"negate": true,
"case_sensitive": true,
"hasError": true
}
],
"filter_operator": "and"
},
"exclude_filters": {
"filters": [
{
"executed": true,
"filter_type": "product_filter",
"operator_fe": "exists",
"name": "product_id",
"data_type": "string",
"operator": "exists",
"value": "<string>",
"negate": true,
"case_sensitive": true,
"hasError": true
}
],
"filter_operator": "and"
},
"custom_settings": {
"item_filters": {
"user_actions": {}
}
},
"sort": {
"data_type": "double",
"param_type": "product_attribute",
"param": "price",
"direction": "1"
},
"trend": {
"type": "most_purchased_items",
"in_the_last": "7_days"
},
"catalog_watch_setting": {
"catalog_attribute": "price",
"operator": "LESS_THAN",
"value": 500,
"type": "absolute",
"compare_to": "previous_value"
},
"trigger_event": false,
"business_event": null
}
]
}Rate Limit
You can make 100 requests per minute and 10,000 requests per day.承認
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.
ヘッダー
クエリパラメータ
This parameter filters the results by the recommendation's status. The supported values are Active, Processing, Archived, and Failed. These values are case-sensitive.
To filter by more than one status, pass the values as a comma-separated list. For example, status=Active,Processing.
If you don't provide this parameter, the response excludes archived recommendations.