Newer Version Available

This content describes an older version of this product. View Latest

Personalization Recommender Creation

Create a personalization recommender.
Resource
1/personalization/personalization-recommenders
Available version
64.0
HTTP method
POST
Request body
Personalization Recommender Input
Response body
Personalization Recommender

Example

Request:

1{
2    "name": "MaximizeRevenueRecommender",
3    "label": "Maximize Revenue Recommender",
4    "description": "Recommender to maximize revenue",
5    "dataSpaceName": "default",
6    "itemDataGraphName": "productDg",
7    "profileDataGraphName": "profileDg",
8    "objectiveName": "MaximizeRevenue",
9    "includeFilters": {
10        "operator": "And",
11        "rules": [
12            {
13                "type": "Field",
14                "fieldName": "ssot__BrandId__c",
15                "predicate": {
16                    "type": "Text",
17                    "operator": "Equals",
18                    "values": ["Nike"]
19                }
20            }
21        ]
22    }
23}

Response:

1{
2    "contentObject": {
3        "label": "Goods Product",
4        "name": "GoodsProduct"
5    },
6    "createdById": "005SG000001skcTYAQ",
7    "createdDate": "2025-02-23T20:27:30.000Z",
8    "dataSpace": {
9        "label": "default",
10        "name": "default"
11    },
12    "excludeFilters": null,
13    "id": "0heSG0000000JlpYAE",
14    "includeFilters": {
15        "operator": "And",
16        "rules": [
17            {
18                "fieldName": "ssot__BrandId__c",
19                "predicate": {
20                    "operator": "Equals",
21                    "type": "Text",
22                    "values": [
23                        "Nike"
24                    ]
25                },
26                "type": "Field"
27            }
28        ]
29    },
30    "itemDataGraph": {
31        "label": "productDg",
32        "name": "Products datagraph"
33    },
34    "label": "Maximize Revenue Recommender",
35    "lastModifiedById": "005SG000001smAMYAY",
36    "lastModifiedDate": "2025-09-05T08:04:02.000Z",
37    "lastRefreshedStatus": "Complete",
38    "lastSuccessfulRefresh": "2025-04-09T16:42:09.000Z",
39    "name": "MaximizeRevenueRecommender",
40    "objective": {
41        "label": "MaximizeRevenue",
42        "name": "MaximizeRevenue"
43    },
44    "profileDataGraph": {
45        "label": "profileDg",
46        "name": "Profile datagraph"
47    },
48    "sortCriteria": {
49        "calculatedInsightLabel": null,
50        "calculatedInsightMetricLabel": null,
51        "sortOrder": null
52    },
53    "status": "Active",
54    "url": "/services/data/v64.0/personalization/personalization-recommenders/0heSG0000000JlpYAE"
55}