Engagement Signal

Response body for an Engagement Signal.

JSON example

This example shows a sample response to create an engagement signal.

1{
2  "id": "1H0xx0000004CAeCAM",
3  "name": "EmailClicks",
4  "label": "Email Clicks",
5  "objectName": "Email_Engagement__dlm",
6  "dataSpaceName": "default",
7  "timestampField": {
8    "objectName": "Email_Engagement__dlm",
9    "name": "CreatedDate__c",
10    "label": "Created Date"
11  },
12  "userIdField": {
13    "objectName": "Email_Engagement__dlm",
14    "name": "IndividualId__c",
15    "label": "Individual"
16  },
17  "uniqueIdentifier": {
18    "objectName": "Email_Engagement__dlm",
19    "name": "Id__c",
20    "label": "Id"
21  },
22  "catalogIdField": {
23    "objectName": "Email_Engagement__dlm",
24    "name": "CampaignId__c",
25    "label": "Campaign"
26  },
27  "filterGroups": [
28    {
29      "conjunctiveOperator": "And",
30      "filters": [
31        {
32          "action": "Includes",
33          "operator": "Equals",
34          "field": {
35            "objectName": "Email_Engagement__dlm",
36            "name": "EngagementTypeId__c",
37            "label": "Engagement Type"
38          },
39          "values": [
40            "CLICK"
41          ]
42        }
43      ]
44    }
45  ],
46  "metrics": [
47    {
48      "id": "1H0xx0000004CAeCAZ",
49      "name": "Clicks_Count",
50      "aggregateFunction": "Count",
51      "field": {
52        "objectName": "Email_Engagement__dlm",
53        "name": "Id__c",
54        "label": "Id"
55      }
56    }
57  ]
58}

This example shows a sample response to get a single engagement signal.

1{
2  "id": "1H0xx0000004CAeCAM",
3  "name": "EmailClicks",
4  "label": "Email Clicks",
5  "objectName": "Email_Engagement__dlm",
6  "dataSpaceName": "default"
7}

Property Name	Type	Description	Filter Group and Version	Available Version
`id`	String	The platform object ID of the Engagement Signal.	Small, 63.0	63.0
`name`	String	The API name of the Engagement Signal.	Small, 63.0	63.0
`label`	String	The label of the Engagement Signal.	Small, 63.0	63.0
`objectName`	String	The API name of the Content Object associated with the Engagement Signal.	Small, 63.0	63.0
`dataSpaceName`	String	The API name of the Data Space associated with the Engagement Signal.	Small, 63.0	63.0
`timestampField`	Field	DateTime field on the content object DMO or its related DMO.	Small, 63.0	63.0
`userIdField`	Field	A field on the content object DMO or its related DMO.	Small, 63.0	63.0
`uniqueIdentifier`	Field	A field on the content object DMO or its related DMO.	Small, 63.0	63.0
`catalogIdField`	Field	A field on the content object DMO or its related DMO.	Small, 63.0	63.0
`distinctFields`	Field[]	Fields on the content object DMO or its related DMOs.	Big, 63.0	63.0
`filterGroups`	Engagement Signal Filter Group[]	List of filter groups.	Big, 63.0	63.0
`metrics`	Engagement Signal Metric[]	List of metrics.	Medium, 63.0	63.0
`parameters`	Engagement Signal Parameter[]	List of parameters.	Medium, 63.0	63.0

Connect REST API Developer Guide

Engagement Signal