Engagement Signals | Connect REST API Developer Guide

Resource

This resource is applicable for POST method.

1/personalization/engagement-signals

This resource is applicable for GET (collection) method.

1/personalization/engagement-signals?queryparameters

The query parameters can include the API name of the data space, the API name of the profile data graph, the API name of the item data graph, a limit for the number of engagement signals returned, and the number of engagement signals to skip before the return.

This resource is applicable for GET (single) and DELETE methods.

1/personalization/engagement-signals/idOrName

The idOrName property is the ID or API name of the engagement signal.

Resource example

This example shows a sample resource applicable for POST method.

1https://yourInstance.salesforce.com/services/data/v67.0/personalization/engagement-signals

This example shows a sample resource applicable for GET (collection) method.

1https://yourInstance.salesforce.com/services/data/v67.0/personalization/engagement-signals?dataspaceName=default&profileDataGraphName=validProfileDG&itemDataGraphName=validItemDG&batchSize=25&offset=0

This example shows a sample resource applicable for GET (single) and DELETE methods.

1https://yourInstance.salesforce.com/services/data/v67.0/personalization/engagement-signals/1H0xx0000004CAeCAM

Available version

63.0

HTTP methods

GET, POST, DELETE

Request Body for POST

JSON Example

1
2{
3  "name": "EmailClicks",
4  "label": "Email Clicks",
5  "objectName": "Email_Engagement__dlm",
6  "dataSpaceName": "default",
7  "timestampField": { "objectName": "Email_Engagement__dlm", "name": "CreatedDate__c" },
8  "userIdField": { "objectName": "Email_Engagement__dlm", "name": "IndividualId__c" },
9  "uniqueIdentifierField": { "objectName": "Email_Engagement__dlm", "name": "Id__c" },
10  "catalogIdField": { "objectName": "Email_Engagement__dlm", "name": "CampaignId__c" },
11  "filterGroups": {
12    "filterGroups": [
13      {
14        "conjunctiveOperator": "And",
15        "filters": [
16          {
17            "action": "Includes",
18            "operator": "Equals",
19            "field": { "objectName": "Email_Engagement__dlm", "name": "EngagementTypeId__c" },
20            "values": ["CLICK"]
21          }
22        ]
23      }
24    ]
25  },
26  "metrics": {
27    "metrics": [
28      {
29        "name": "Clicks_Count",
30        "aggregateFunction": "Count",
31        "field": { "objectName": "Email_Engagement__dlm", "name": "Id__c" }
32      }
33    ]
34  }
35}

Name	Type	Description	Required or Optional	Available Version
`name`	String	The API name of the Engagement Signal.	Required	63.0
`label`	String	The label of the Engagement Signal.	Required	63.0
`objectName`	String	The API name of the Content Object DMO with the Engagement Signal.	Required	63.0
`dataSpaceName`	String	The API name of the Data Space associated with the Engagement Signal.	Required	63.0
`timestampField`	Field Input	DateTime field on the content object DMO or its related DMO.	Required	63.0
`userIdField`	Field Input	A field on the content object DMO or its related DMO.	Required	63.0
`uniqueIdentifierField`	Field Input	A field on the content object DMO or its related DMO.	Required	63.0
`catalogIdField`	Field Input	A field on the content object DMO or its related DMO.	Optional	63.0
`distinctFields`	Field Input[]	Fields on the content object DMO or its related DMOs.	Optional	63.0
`filterGroups`	Engagement Signal Filter Group Collection Input	Engagement Signal Filter Group Collection.	Optional	63.0
`metrics`	Engagement Signal Metric Collection Input	Engagement Signal Metrics.	Optional	63.0
`parameters`	Engagement Signal Parameter Collection Input	Engagement Signal Parameters.	Optional	63.0

Response body for POST

Engagement Signal

Query Parameters for GET (collection)

Name	Type	Description	Required or Optional	AVAILABLE VERSION
`dataspaceName`	String	API name of the Data Space to filter by.	Optional	63.0
`profileDataGraphName`	String	API name of the Profile Data Graph to filter by.	Optional	63.0
`itemDataGraphName`	String	API name of the Item Data Graph to filter by.	Optional	66.0
`limit`	Integer	Maximum number of items to return.	Optional	63.0
`offset`	Integer	Number of items to skip before starting to collect the result set.	Optional	63.0

Response body for GET (collection)

Engagement Signal Collection

Response body for GET (single)

Engagement Signal