Subject Contacts

The Subject Contacts API records contacts to subjects and records documents that are produced when executing decisions and business rules.

Root

Contains the operations for the root resource.

Get a list of top-level resource links

Internal-Use OnlyReturns a list of links to the top-level resources in this API.

Contacts

Contains the operations for the contacts resource.

Get all contacts

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

Create a new contact record

Internal-Use OnlyThe contact and response are recorded. If the presentation is configured to be recorded, it can be recorded at this time or deferred to a future update. The PATCH action can be used with the responseTrackingCode property to make the update and record the response to the treatment. If the operation is to be fulfilled asynchronously by using asynchronous=true, a resource ID is issued without waiting for the completion of the operation. The endpoint returns a URI for retrieving the resource in the Location response header. An HTTP status of 202 is returned.

Export contact records

Internal-Use OnlyExports contacts as CSV text. A filter can be used to select the contacts. If a filter is not used, all contacts are returned. The output is not pageable nor sortable. A header is not returned by default. To add a header, add the header=present option to the text/csv media type. The columns are:

Create contact records from CSV

Internal-Use OnlyCreates contact records from a CSV file. It imports the CSV text with a header row that specifies the order of these required columns:

Get a contact

Internal-Use OnlyReturns information about the contact.

/contacts/{contactId}

Update a contact record

Internal-Use OnlyUpdates the contact record by replacing it. Use this endpoint to update the presentation or the response of the treatments in the contact. Presentation and responses can be updated multiple times. For example, a subject clicking a treatment link is one type of response and subsequent engagement (for example, taking the next step in a commercial flow) is another response. Depending on how the merchant wants to track responses, it can be multiple updates or just one update of the final response. Although some members of the contact record have changed, the full contact object is required for this action. Since some members are immutable, an error occurs if you attempt to change them. Furthermore, if a member is an array, it is an error to change the number of entries in the array. These are the immutable first and second-level members of the record:

/contacts/{contactId}

Patch a contact record

Internal-Use OnlyPatches a contact record by sending a partial representation of the contact record, which includes a key field and the fields that are to be changed. The full object is sent in the response. If a field in the partial representation has the 'null' value, it is interpreted to mean that a value is not sent rather than having the value in the field erased.

/contacts/{contactId}

Delete a contact record

Internal-Use OnlyDeletes a contact record.

/contacts/{contactId}

Aggregations

Contains the operations for the aggregations resource.

Use a query to answer several related queries

Internal-Use OnlyReturns information about the treatments. In anticipating queries like how many times a subject has been contacted in the last N time-units through X channels for different values of N, for multiple time units, for different channel values X, this endpoint allows the user to provide the parameters so that these queries can be answered at once by aggregating the results of multiple queries. This is done by combining different values of time, time unit, contact channel and response channel.

Traces

Contains the operations for the traces resource.

Get decision traces

Internal-Use OnlyReturns a collection of decision traces. The traces can either be returned in either text/tab-separated-values or application/vnd.sas.collection+json format. The former would be the same format used for adding a decision trace. In the latter format, the traces without the actual trace texts are returned as items in a collection.

Append text or update traces from TSV

Internal-Use OnlyAppends text to the collection or updates the processorNote field of appended text. There are two types of traces: one is at the decision step boundary and other is at the variable assignment. The scope query parameter is used to specify the type of trace.

Delete traces

Internal-Use OnlyDeletes traces produced by decision execution.

Process a trace and store a report file

Internal-Use OnlyProcesses a trace and stores the report in a file resource in the Files service. A text report is produced from the raw trace. The text report for a decision step boundary provides the following information:

/traces/{traceId}/process