Get KPI data for a Profile ID (Hub Data)

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

Gets data for the specified KPI that is associated with specified Profile instance, with optional filtering.

Request

The request is constructed as follows:

HTTP Verb Request URI
GET <hub-endpoint>/data/Contacts('<contactId>')/KPIs(KpiName='<kpiName>',WindowType='<period>')/Values?api-version=2017-04-26

URI Parameters

URI Parameter Required Description
Hub-endpoint Yes The base URL for your Customer Insights Hub.
contactId Yes Strong ID of the profile. This should also be included in the group by of the KPI
kpiName Yes Name of the KPI type to retrieve data for
period Yes Standard time period for KPI calculation

Comlpex filter expressions can also be applied to this operation as demonstrated in the following request.

GET <hub-endpoint>/data/Contacts('4')/KPIs(KpiName='EmailSentCount',WindowType='Day')/Values?
        $filter=Timestamp gt cast('2014-01-01T23:59:59.999Z', Edm.DateTimeOffset)&api-version=2017-04-26

All the filter operations mentioned in Kpi Query Data can be applied here as well.


Response

The response includes an HTTP status code, a response body and a set of response headers.

Response Body

A collection of custom data for the specified KPI.

Status Code

  • 200 (OK) - the request succeeded.