API Requests and Responses

[This topic is pre-release documentation and is subject to change.]

All of the Customer Insights APIs conform to REST conventions. Each entity type, such as a Customer Insights Hub is a resource exposed as a REST endpoint. Each endpoint exposes a set of CRUD operations, often a subset of the standard CRUD operations listed in the following table. The "Idemp?" column indicates whether the operation is idempotent, i.e. whether making multiple identical requests yields the same result.

Operation HTTP Verb Type/Idem? Description
Get (Retrieve) GET Read/True Returns the single, specified instance
List GET Read/True Returns all the instances of the specified entity type
Create/Update (Upsert) PUT Write/True Creates a new or updates an existing instance
Generate/Modify POST Write/False Generate information or run a command
Update PATCH Write/False [Partially] updates an existing instance
Delete DELETE Write/True Deletes an existing instance

Because Customer Insight is an Azure-based REST service, its Azure Resource Manager (ARM) APIs follow the common requirements and conventions documented in the topic Azure REST API Reference. Note that some types constrain the possible operations; for example in the current release, Interaction and Profile instances cannot be deleted, images can only be uploaded, and so on.

The general form of the request depends upon the API group being used, either Azure Resource Manager (ARM) APIs or Customer Insights Hub APIs. Although the base portion differs between these two APIs, there is a much commonality in the exposed resources and their respective operations. For a comparison of these APIs, see the API Quick Reference.

API Versioning

The query string api-version specifies the desired version of the Customer Insights API to be invoked. The recognized dates correspond to releases as follows:

Version Description
"2016-01-01" Initial pre-release
"2017-04-26" Second pre-release

With each major release of Customer Insights, the corresponding API version will change to reflect its version. This online reference documentation only covers the most recent version.

Returned Collections

List operations, for example List Hubs (ARM), typically return linked collections of the form:

    "value": [<array-of-entity-instances>]
    "nextLink": "<string-URL>" 

Where the optional nextLink property points to the next "page" of results. (This property will be missing if there are no additional results.) Returning "chunked" results is a compromise between returning a single value at a time and returning a potentially large resultset. By default, a maximum of 30 instances are returned by each response, although this can be limited through the use of OData $top query parameter, for example:


OData APIs and Metadata Requests

All of the Customer Insights Hub APIs conform to the OData standard. One result of this adherence is that each solution exposes its metadata endpoint, which is accessed by a request of the form:

GET <hub-endpoint>/data/$metadata

For example:


Return Codes

As expected for a REST service, the Customer Insights APIs return standard HTTP status codes. The documentation for each operation only lists the most common or informative ones.

Reserved Words

For each of the management APIs, there is a number of reserved keywords that are disallowed when specifying the names of various custom entities and their properties. However it is recommended that the following reserved words not be used for any purpose other than their intended keyword usage.

Active AgentProfileId CalculationTime CountValue InteractionId
Key KPITime LastModified LastModifiedUtcDateTimeTicks MaxValue
MinValue ProfileId reserved_system_time SumValue UtcDateTime

It is also recommended that you do not use standard type names, for example "KPI", as variable names.