Queries the recommendation results of a specified instance.
Debugging
Authorization information
Request syntax
GET /v2/openapi/instances/{instanceId}/actions/recommend
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
instanceId | string | Yes | The ID of the instance. | airec-test001 |
sceneId | string | No | The number of result entries to return. Valid values: 0 to 50. | test |
userId | string | Yes | The items used for related recommendations in specified scenes. | 123 |
ip | string | No | The HTTP status code. | 192.168.1.1 |
imei | string | No | The ID of the scene in which the item is to be recommended. | 06e1565409c9fc4887036b974421**** |
returnCount | integer | Yes | The returned results. | 10 |
items | string | No | The information about event tracking. The value of this parameter varies based on different items and needs to be uploaded together with the corresponding behavior data. | 1001 |
serviceType | string | No | The position at which the recommended item is displayed. The position number starts from 0. The return results are ranked by position. You can ignore this parameter. | 1 |
userInfo | string | No | The ID of the request. | 1 |
rankOpen | boolean | No | N/A | true |
recType | string | No | The type of the recommended item. | gul |
filter | string | No | The status of the execution. | eyJqb2luIjoiYW5kIiwiZmlsdGVycyI6W3siY29uZCI6ImNvbnRhaW4iLCJmaWVsZCI6InRhZ3MiLCJ2YWx1ZSI6IuWPjOS6uiJ9XX0. |
Response parameters
Examples
Sample success responses
JSON
format
{
"result": [
{
"matchInfo": "xxx",
"traceId": "ali",
"position": 1,
"itemId": "123",
"itemType": "item",
"traceInfo": "\"1007.62381.131491.100200300000000:bcb946ed-3f09-4e9b-bf4a-c19862f42231:792783::0:s101:::15:content___130788_stall:item:i2i_common_common:0.0205279946753756:null:null:1673258031504::context__recall_index=156,context__hour=17,context__trigger_num=2::C7EF99C9-6C55-5D45-A8D5-0754082E9DCF:hot_common,i2i_common_common,i2i_swing_common,hot_full:::::\"",
"weight": 1,
"flowWeight": 0,
"message": "Successful"
}
],
"code": "200",
"requestId": "04707E49-642A-4649-827A-F8EEB07D4C27",
"message": "\"i2i_common_common;NotFound;1673254401;similar product/content of clicked ones;2023-01-09 16:53:21\""
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||
---|---|---|---|---|---|---|
2023-03-20 | The request parameters of the API has changed | see changesets | ||||
|