Get all contacts

get/contacts

Internal-Use Only

Returns a collection of information about each contact made. Each item also contains the presentation, and the response to that contact.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "name": "contacts",
3  "accept": "application/vnd.sas.decision.subject.contact",
4  "count": 2,
5  "start": 0,
6  "limit": 5,
7  "items": [
8    {
9      "creationTimeStamp": "2018-05-13T15:02:40.719Z",
10      "modifiedTimeStamp": "2018-05-13T18:32:40.719Z",
11      "createdBy": "joeMarket",
12      "modifiedBy": "joeMarket",
13      "id": "5195ceb6-228e-439d-b3df-307197f1e7a7",
14      "subjectId": "Francis.Albert.Bacon.19195313421",
15      "subjectLevel": "household",
16      "objectUri": "/decisions/flows/5c5bc46a-cea0-4102-a88c-71cf1506e2c5",
17      "objectRevisionId": "afb62877-64cb-4ae6-bf0c-4e2783a38d3a",
18      "objectType": "decision",
19      "objectVariables": [
20        {
21          "id": "a4722451-fb6f-4c9a-8bb8-4cf1eaba73c0",
22          "name": "ov1",
23          "value": "A",
24          "dataType": "string"
25        },
26        {
27          "id": "395aebd9-1646-4d84-9c05-d8e80efe72b7",
28          "name": "ov2",
29          "value": "B",
30          "dataType": "string"
31        }
32      ],
33      "treatmentsForConsideration": [
34        {
35          "id": "f025ee1f-a60a-4bb5-8236-0c697562653e",
36          "treatmentId": "4f3f14cf-69ed-4d59-9ea2-ecfb525cfa83",
37          "treatmentRevisionId": "7aa86c12-55cf-4e99-8060-5b516314dc44",
38          "treatmentGroupId": "bc912f15-96a0-4991-ba2a-9f12491cefc0",
39          "treatmentGroupRevisionId": "9d2fccaa-428a-4604-a242-4f259ab8a553",
40          "objectNodeId": "6bf8f1b3-9910-40ad-8146-6affd4f49a1f",
41          "presented": true,
42          "presentedTimeStamp": "2018-05-13T15:02:40.719Z",
43          "subjectContactId": "5195ceb6-228e-439d-b3df-307197f1e7a7"
44        },
45        {
46          "id": "383bebdf-9378-4ed9-a2f3-127f53acfd22",
47          "treatmentId": "826c9635-809a-44cf-a982-63e374846087",
48          "treatmentRevisionId": "d14e393d-c21c-4654-8095-376909edace5",
49          "treatmentGroupId": "1ba80181-7996-4ed5-8d58-66be8d2204e3",
50          "treatmentGroupRevisionId": "f38725dc-cb53-4f09-b69c-661a7d675dac",
51          "objectNodeId": "cf328b78-81b3-465e-b86b-2eb71876a66a",
52          "presented": true,
53          "presentedTimeStamp": "2018-05-13T15:02:40.719Z",
54          "responseValue": "accepted",
55          "responseType": "rt_1",
56          "respondedTimeStamp": "2018-05-13T18:11:10.687Z",
57          "responseChannel": "web",
58          "subjectContactId": "5195ceb6-228e-439d-b3df-307197f1e7a7"
59        },
60        {
61          "id": "23c1ebb8-7df8-4555-92d7-226ad88ad734",
62          "treatmentId": "2826de5a-d0d6-4bd1-8a80-08c12ba2ad81",
63          "treatmentRevisionId": "f14c3aa2-98a4-4a42-8b29-c99ad3cc02a8",
64          "treatmentGroupId": "1ba80181-7996-4ed5-8d58-66be8d2204e3",
65          "treatmentGroupRevisionId": "f38725dc-cb53-4f09-b69c-661a7d675dac",
66          "objectNodeId": "f7d361a9-d488-47f6-a579-e4cf28fb7324",
67          "presented": true,
68          "presentedTimeStamp": "2018-05-13T15:02:40.719Z",
69          "subjectContactId": "5195ceb6-228e-439d-b3df-307197f1e7a7"
70        }
71      ],
72      "ruleFired": "00010",
73      "pathTraversed": "/9e4e324b-de68-4035-b511-84cd558d5408/2541ab6e-3e7d-4ba0-8f04-7fc13a8e9794/509c4d2d-dc2c-4cb3-a094-5628e1ec879d",
74      "abTests": [
75        {
76          "id": "f025ee1f-a60a-4bb5-8236-0c697562653f",
77          "nodeId": "4f3f14cf-69ed-4d59-9ea2-ecfb525cfa86",
78          "champion": true,
79          "pathName": "Champion",
80          "pathId": "9d2fccaa-428a-4604-a242-4f259ab8a555",
81          "pathKey": "term1Name",
82          "pathType": "Champion/Challenger"
83        }
84      ],
85      "responseTrackingCode": "GreatCustomer.07f16e7a-db89-400a-91d9-8b6868f07b7b",
86      "receiverId": "Francis.Albert.Bacon.19195313421",
87      "receiverRole": "customer",
88      "excludeFromContactRule": false,
89      "channel": "web",
90      "conclusionResponseValue": "",
91      "conclusionResponseType": "crt_x",
92      "version": 1,
93      "links": [
94        {
95          "method": "GET",
96          "rel": "self",
97          "href": "/subjectContacts/contacts/5195ceb6-228e-439d-b3df-307197f1e7a7",
98          "uri": "/subjectContacts/contacts/5195ceb6-228e-439d-b3df-307197f1e7a7",
99          "type": "application/vnd.sas.decision.subject.contact"
100        },
101        {
102          "method": "PUT",
103          "rel": "update",
104          "href": "/subjectContacts/contacts/5195ceb6-228e-439d-b3df-307197f1e7a7",
105          "uri": "/subjectContacts/contacts/5195ceb6-228e-439d-b3df-307197f1e7a7",
106          "type": "application/vnd.sas.decision.subject.contact",
107          "responseType": "application/vnd.sas.decision.subject.contact"
108        },
109        {
110          "method": "POST",
111          "rel": "create",
112          "href": "/subjectContacts/contacts",
113          "uri": "/subjectContacts/contacts",
114          "type": "application/vnd.sas.decision.subject.contact",
115          "responseType": "application/vnd.sas.decision.subject.contact"
116        },
117        {
118          "method": "PATCH",
119          "rel": "patch",
120          "href": "/subjectContacts/contacts/5195ceb6-228e-439d-b3df-307197f1e7a7",
121          "uri": "/subjectContacts/contacts/5195ceb6-228e-439d-b3df-307197f1e7a7",
122          "type": "application/vnd.sas.decision.subject.contact",
123          "responseType": "application/vnd.sas.decision.subject.contact"
124        },
125        {
126          "method": "DELETE",
127          "rel": "delete",
128          "href": "/subjectContacts/contacts/5195ceb6-228e-439d-b3df-307197f1e7a7",
129          "uri": "/subjectContacts/contacts/5195ceb6-228e-439d-b3df-307197f1e7a7"
130        },
131        {
132          "method": "GET",
133          "rel": "up",
134          "href": "/subjectContacts/contacts",
135          "uri": "/subjectContacts/contacts",
136          "type": "application/vnd.sas.collection",
137          "itemType": "application/vnd.sas.decision.subject.contact"
138        }
139      ]
140    },
141    {
142      "creationTimeStamp": "2018-05-13T18:01:01.203Z",
143      "modifiedTimeStamp": "2018-05-13T18:01:01.203Z",
144      "createdBy": "joeMarket",
145      "modifiedBy": "joeMarket",
146      "id": "39657793-736b-462f-8d37-31c04b680657",
147      "objectUri": "/decisions/flows/525b199b-9073-4359-a521-ff1bc8a59145",
148      "objectRevisionId": "e4728fe2-35ce-4ac6-84e0-fd0cad3f0e80",
149      "objectType": "decision",
150      "objectVariables": [
151        null,
152        {
153          "name": "ov1",
154          "value": "A",
155          "dataType": "string"
156        },
157        {
158          "name": "ov2",
159          "value": "B",
160          "dataType": "string"
161        }
162      ],
163      "subjectId": "Francis.Albert.Bacon.19195313421",
164      "subjectLevel": "household",
165      "ruleFired": "111101",
166      "pathTraversed": "/ddc3f087-e313-4f63-8404-45a51257df0b/5cb79bb7-1ba2-4c1d-a17c-5d0894ebc046/1111ee7e-7135-4397-bb1d-2aa0a680b9aa",
167      "responseTrackingCode": "BigSaver.08c3f2f6-2d1f-45ed-9cd4-511fa7b40054",
168      "receiverId": "CallCenter.71.310",
169      "receiverRole": "agent",
170      "conclusionResponseValue": "",
171      "conclusionResponseType": "crt_x",
172      "treatmentsForConsideration": [
173        {
174          "id": "7b34d631-2f16-4d7a-ac55-3cbe9a661a6c",
175          "subjectContactId": "39657793-736b-462f-8d37-31c04b680657",
176          "treatmentId": "29ed1a67-e3be-412c-ae2f-567edd38e086",
177          "treatmentRevisionId": "efb511c1-ad37-4a3d-8a8f-e259d8dc2812",
178          "treatmentGroupId": "82d4e377-16ab-4165-a923-c38c45cd3a01",
179          "treatmentGroupRevisionId": "2c72fe78-09df-44ff-9039-23f1272390b9",
180          "objectNodeId": "3670f308-fe1a-46b0-96de-b97a09db0be5",
181          "presented": false
182        }
183      ],
184      "abTests": [
185        {
186          "id": "f025ee1f-a60a-4bb5-8236-0c6975626531",
187          "nodeId": "4f3f14cf-69ed-4d59-9ea2-ecfb525cfa82",
188          "champion": false,
189          "pathName": "challenger",
190          "pathId": "9d2fccaa-428a-4604-a242-4f259ab8a559",
191          "pathKey": "term1Name",
192          "pathType": "Champion/Challenger"
193        }
194      ],
195      "excludeFromContactRule": false,
196      "channel": "phone",
197      "version": 1,
198      "links": [
199        {
200          "method": "GET",
201          "rel": "self",
202          "href": "/subjectContacts/contacts/39657793-736b-462f-8d37-31c04b680657",
203          "uri": "/subjectContacts/contacts/39657793-736b-462f-8d37-31c04b680657",
204          "type": "application/vnd.sas.decision.subject.contact"
205        },
206        {
207          "method": "PUT",
208          "rel": "update",
209          "href": "/subjectContacts/contacts/39657793-736b-462f-8d37-31c04b680657",
210          "uri": "/subjectContacts/contacts/39657793-736b-462f-8d37-31c04b680657",
211          "type": "application/vnd.sas.decision.subject.contact",
212          "responseType": "application/vnd.sas.decision.subject.contact"
213        },
214        {
215          "method": "POST",
216          "rel": "create",
217          "href": "/subjectContacts/contacts",
218          "uri": "/subjectContacts/contacts",
219          "type": "application/vnd.sas.decision.subject.contact",
220          "responseType": "application/vnd.sas.decision.subject.contact"
221        },
222        {
223          "method": "PATCH",
224          "rel": "patch",
225          "href": "/subjectContacts/contacts/39657793-736b-462f-8d37-31c04b680657",
226          "uri": "/subjectContacts/contacts/39657793-736b-462f-8d37-31c04b680657",
227          "type": "application/vnd.sas.decision.subject.contact",
228          "responseType": "application/vnd.sas.decision.subject.contact"
229        },
230        {
231          "method": "DELETE",
232          "rel": "delete",
233          "href": "/subjectContacts/contacts/39657793-736b-462f-8d37-31c04b680657",
234          "uri": "/subjectContacts/contacts/39657793-736b-462f-8d37-31c04b680657"
235        },
236        {
237          "method": "GET",
238          "rel": "up",
239          "href": "/subjectContacts/contacts",
240          "uri": "/subjectContacts/contacts",
241          "type": "application/vnd.sas.collection",
242          "itemType": "application/vnd.sas.decision.subject.contact"
243        }
244      ]
245    }
246  ],
247  "links": [
248    {
249      "method": "GET",
250      "rel": "collection",
251      "href": "/subjectContacts/contacts",
252      "uri": "/subjectContacts/contacts",
253      "type": "application/vnd.sas.collection",
254      "itemType": "application/vnd.sas.decision.subject.contact"
255    },
256    {
257      "method": "GET",
258      "rel": "self",
259      "href": "/subjectContacts/contacts?limit=5&filter=and(eq(subjectId,'Francis.Albert.Bacon.19195313421'),eq(subjectLevel,'household'))&sortBy=creationTimeStamp:ascending&start=0",
260      "uri": "/subjectContacts/contacts?limit=5&filter=and(eq(subjectId,'Francis.Albert.Bacon.19195313421'),eq(subjectLevel,'household'))&sortBy=creationTimeStamp:ascending&start=0",
261      "type": "application/vnd.sas.collection",
262      "itemType": "application/vnd.sas.decision.subject.contact"
263    },
264    {
265      "method": "GET",
266      "rel": "up",
267      "href": "/subjectContacts/",
268      "uri": "/subjectContacts/",
269      "type": "application/vnd.sas.api"
270    },
271    {
272      "method": "POST",
273      "rel": "create",
274      "href": "/subjectContacts/contacts",
275      "uri": "/subjectContacts/contacts",
276      "type": "application/vnd.sas.decision.subject.contact",
277      "responseType": "application/vnd.sas.decision.subject.contact"
278    }
279  ],
280  "version": 2
281}

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	The filter criteria for the returned contacts. All fields of application/vnd.sas.decision.subject.contact can be used in the filter.
limit	integer	false	The maximum number of items to return on this page. The actual number of returned items might be less if there are no more items in the collection. The default is 10.
sortBy	string<sort-criteria>	false	The sorting criteria for the returned contacts. The default sort order is creationTimeStamp:descending.
start	integer	false	The starting index of the first item on a page. The index is 0-based. The default index is 0.

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	Select the desired item representation. Allowed values: application/vnd.sas.decision.subject.contact+jsonapplication/vnd.sas.search.indexable.data+jsonapplication/vnd.sas.summary+json Default: application/vnd.sas.summary+json

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.	Headers	Schema
404	Not Found	No resource exists at the requested path.	Headers	Schema