| POST,OPTIONS | /v1/dashboard/kpiv2 |
|---|
"use strict";
export class DashboardStatTile {
/** @param {{Key?:string,Label?:string,Value?:number,PreviousValue?:number,Unit?:string,DeltaPct?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Label;
/** @type {number} */
Value;
/** @type {?number} */
PreviousValue;
/** @type {string} */
Unit;
/** @type {?number} */
DeltaPct;
}
export class DashboardSeriesPoint {
/** @param {{Label?:string,Value?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Label;
/** @type {number} */
Value;
}
export class DashboardSeries {
/** @param {{Name?:string,Points?:DashboardSeriesPoint[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {DashboardSeriesPoint[]} */
Points = [];
}
export class KpiV2LocationRow {
/** @param {{LocationName?:string,Walkins?:number,Completed?:number,AvgServiceMinutes?:number,AbandonmentPct?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
LocationName;
/** @type {number} */
Walkins;
/** @type {number} */
Completed;
/** @type {number} */
AvgServiceMinutes;
/** @type {number} */
AbandonmentPct;
}
export class KpiV2WorkerRow {
/** @param {{WorkerName?:string,Completed?:number,AvgServiceMinutes?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
WorkerName;
/** @type {number} */
Completed;
/** @type {number} */
AvgServiceMinutes;
}
export class KpiV2HeatPoint {
/** @param {{Dow?:number,Hr?:number,Cnt?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Dow;
/** @type {number} */
Hr;
/** @type {number} */
Cnt;
}
export class KpiV2LiveRow {
/** @param {{LocationName?:string,Waiting?:number,InProgress?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
LocationName;
/** @type {number} */
Waiting;
/** @type {number} */
InProgress;
}
export class KpiV2Response {
/** @param {{ResponseStatus?:ResponseStatus,Stats?:DashboardStatTile[],Trend?:DashboardSeries[],ServicesByType?:DashboardSeries,LocationLeaderboard?:KpiV2LocationRow[],WorkerProductivity?:KpiV2WorkerRow[],Heatmap?:KpiV2HeatPoint[],LiveQueue?:KpiV2LiveRow[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {DashboardStatTile[]} */
Stats = [];
/** @type {DashboardSeries[]} */
Trend = [];
/** @type {DashboardSeries} */
ServicesByType;
/** @type {KpiV2LocationRow[]} */
LocationLeaderboard = [];
/** @type {KpiV2WorkerRow[]} */
WorkerProductivity = [];
/** @type {KpiV2HeatPoint[]} */
Heatmap = [];
/** @type {KpiV2LiveRow[]} */
LiveQueue = [];
}
export class KpiV2Request {
/** @param {{FromDate?:string,ToDate?:string,LocationIds?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FromDate;
/** @type {string} */
ToDate;
/** @type {string[]} */
LocationIds = [];
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>