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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FromDate: 0001-01-01,
	ToDate: 0001-01-01,
	LocationIds: 
	[
		00000000000000000000000000000000
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Stats: 
	[
		{
			Key: String,
			Label: String,
			Value: 0,
			PreviousValue: 0,
			Unit: String
		}
	],
	Trend: 
	[
		{
			Name: String,
			Points: 
			[
				{
					Label: String,
					Value: 0
				}
			]
		}
	],
	ServicesByType: 
	{
		Name: String,
		Points: 
		[
			{
				Label: String,
				Value: 0
			}
		]
	},
	LocationLeaderboard: 
	[
		{
			LocationName: String,
			Walkins: 0,
			Completed: 0,
			AvgServiceMinutes: 0,
			AbandonmentPct: 0
		}
	],
	WorkerProductivity: 
	[
		{
			WorkerName: String,
			Completed: 0,
			AvgServiceMinutes: 0
		}
	],
	Heatmap: 
	[
		{
			Dow: 0,
			Hr: 0,
			Cnt: 0
		}
	],
	LiveQueue: 
	[
		{
			LocationName: String,
			Waiting: 0,
			InProgress: 0
		}
	]
}