Trendsic Platform Service

KpiV2Request

The following routes are available for this service:
POST,OPTIONS	/v1/dashboard/kpiv2

**KpiV2Request** Parameters:
Name	Parameter	Data Type	Required
FromDate	body	DateTime	No
ToDate	body	DateTime	No
LocationIds	body	List<Guid>	No

**KpiV2Response** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Stats	form	List<DashboardStatTile>	No
Trend	form	List<DashboardSeries>	No
ServicesByType	form	DashboardSeries	No
LocationLeaderboard	form	List<KpiV2LocationRow>	No
WorkerProductivity	form	List<KpiV2WorkerRow>	No
Heatmap	form	List<KpiV2HeatPoint>	No
LiveQueue	form	List<KpiV2LiveRow>	No

**DashboardStatTile** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Label	form	string	No
Value	form	double	No
PreviousValue	form	double?	No
Unit	form	string	No
DeltaPct	form	double?	No

**DashboardSeries** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Points	form	List<DashboardSeriesPoint>	No

**DashboardSeriesPoint** Parameters:
Name	Parameter	Data Type	Required	Description
Label	form	string	No
Value	form	double	No

**KpiV2LocationRow** Parameters:
Name	Parameter	Data Type	Required
LocationName	form	string	No
Walkins	form	int	No
Completed	form	int	No
AvgServiceMinutes	form	double	No
AbandonmentPct	form	double	No

**KpiV2WorkerRow** Parameters:
Name	Parameter	Data Type	Required
WorkerName	form	string	No
Completed	form	int	No
AvgServiceMinutes	form	double	No

**KpiV2HeatPoint** Parameters:
Name	Parameter	Data Type	Required
Dow	form	int	No
Hr	form	int	No
Cnt	form	int	No

**KpiV2LiveRow** Parameters:
Name	Parameter	Data Type	Required
LocationName	form	string	No
Waiting	form	int	No
InProgress	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dashboard/kpiv2 HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<KpiV2Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FromDate>0001-01-01T00:00:00</FromDate>
  <LocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </LocationIds>
  <ToDate>0001-01-01T00:00:00</ToDate>
</KpiV2Request>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<KpiV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Heatmap>
    <KpiV2HeatPoint>
      <Cnt>0</Cnt>
      <Dow>0</Dow>
      <Hr>0</Hr>
    </KpiV2HeatPoint>
  </Heatmap>
  <LiveQueue>
    <KpiV2LiveRow>
      <InProgress>0</InProgress>
      <LocationName>String</LocationName>
      <Waiting>0</Waiting>
    </KpiV2LiveRow>
  </LiveQueue>
  <LocationLeaderboard>
    <KpiV2LocationRow>
      <AbandonmentPct>0</AbandonmentPct>
      <AvgServiceMinutes>0</AvgServiceMinutes>
      <Completed>0</Completed>
      <LocationName>String</LocationName>
      <Walkins>0</Walkins>
    </KpiV2LocationRow>
  </LocationLeaderboard>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ServicesByType>
    <Name>String</Name>
    <Points>
      <DashboardSeriesPoint>
        <Label>String</Label>
        <Value>0</Value>
      </DashboardSeriesPoint>
    </Points>
  </ServicesByType>
  <Stats>
    <DashboardStatTile>
      <Key>String</Key>
      <Label>String</Label>
      <PreviousValue>0</PreviousValue>
      <Unit>String</Unit>
      <Value>0</Value>
    </DashboardStatTile>
  </Stats>
  <Trend>
    <DashboardSeries>
      <Name>String</Name>
      <Points>
        <DashboardSeriesPoint>
          <Label>String</Label>
          <Value>0</Value>
        </DashboardSeriesPoint>
      </Points>
    </DashboardSeries>
  </Trend>
  <WorkerProductivity>
    <KpiV2WorkerRow>
      <AvgServiceMinutes>0</AvgServiceMinutes>
      <Completed>0</Completed>
      <WorkerName>String</WorkerName>
    </KpiV2WorkerRow>
  </WorkerProductivity>
</KpiV2Response>