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
IncludeScope	body	bool	No
StateCode	body	string	No
Compare	body	string	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
Scope	form	SvcScope	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

**SvcScope** Parameters:
Name	Parameter	Data Type	Required
StateCode	form	string	No
Branches	form	List<SvcBranchRow>	No
States	form	List<SvcStateRow>	No
Total	form	SvcMetrics	No
Comparison	form	SvcComparison	No
FeesByService	form	List<SvcServiceRow>	No
ByHour	form	List<SvcHourRow>	No
Workers	form	List<SvcWorkerRow>	No
MultiZone	form	bool	No
MultiState	form	bool	No
RecordingSinceUtc	form	DateTime?	No
SessionsSinceUtc	form	DateTime?	No
Alerts	form	List<SvcAlert>	No
CanSeeStaff	form	bool	No
CanSeeFinancial	form	bool	No
CanSeePay	form	bool	No

**SvcBranchRow** Parameters:
Name	Parameter	Data Type	Required
BranchId	form	Guid	No
Name	form	string	No
StateCode	form	string	No
ZoneCode	form	string	No
TimeZone	form	string	No
Windows	form	int	No
RecordingSinceUtc	form	DateTime?	No
SessionsSinceUtc	form	DateTime?	No
Metrics	form	SvcMetrics	No

**SvcMetrics** Parameters:
Name	Parameter	Data Type	Required
Checkins	form	int	No
Walkins	form	int	No
Appts	form	int	No
Served	form	int	No
NoShows	form	int	No
ApptNoShows	form	int	No
CancelledAtWindow	form	int	No
Abandoned	form	int	No
Called	form	int	No
CalledUp	form	int	No
AbandonRate	form	double?	No
NoShowRate	form	double?	No
AvgServiceSec	form	double?	No
MedianServiceSec	form	double?	No
AvgWaitSec	form	double?	No
MaxWaitSec	form	int	No
AvgWalkUpSec	form	double?	No
ExpectedServiceSec	form	double?	No
SignedSec	form	long	No
ServingSec	form	long	No
PausedSec	form	long	No
IdleSec	form	long	No
UnstaffedSec	form	long	No
Utilization	form	double?	No
IdleShare	form	double?	No
PausedShare	form	double?	No
Sessions	form	int	No
OpenDays	form	int	No
FeesEarned	form	decimal?	No
AvgFee	form	decimal?	No
FeesPerStaffedHour	form	decimal?	No
ExpectedFeesPerStaffedHour	form	decimal?	No
LaborCost	form	decimal?	No
LaborPartial	form	bool	No
MissingCostEmployeeIds	form	List<Guid>	No
MissingCost	form	List<SvcNamedTime>	No
LaborLocked	form	bool	No
Contribution	form	decimal?	No
LostFees	form	decimal?	No
LostNoShowFees	form	decimal?	No
Mix	form	Dictionary<Guid, int>	No
HourlyServed	form	int[]	No
HourlyFees	form	decimal[]	No
HourlyCost	form	decimal[]	No
Tints	form	List<SvcTint>	No

**SvcNamedTime** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
SignedSec	form	long	No
Served	form	int	No

**SvcTint** Parameters:
Name	Parameter	Data Type	Required
Field	form	string	No
Tone	form	string	No
Reason	form	string	No
Value	form	double?	No
Reference	form	double?	No
BranchValue	form	double?	No

**SvcStateRow** Parameters:
Name	Parameter	Data Type	Required
StateCode	form	string	No
StateName	form	string	No
Branches	form	int	No
Metrics	form	SvcMetrics	No

**SvcComparison** Parameters:
Name	Parameter	Data Type	Required
Mode	form	string	No
FromDate	form	DateTime?	No
ToDate	form	DateTime?	No
CutoffMinute	form	int?	No
HasData	form	bool	No
Metrics	form	SvcMetrics	No

**SvcServiceRow** Parameters:
Name	Parameter	Data Type	Required
LineId	form	Guid	No
Name	form	string	No
Completed	form	int	No
AvgServiceSec	form	double?	No
BranchAvgServiceSec	form	double?	No
FeesEarned	form	decimal?	No
FeeCurrent	form	decimal?	No
FeeMin	form	decimal?	No
FeeMax	form	decimal?	No
FeePerMinute	form	decimal?	No
BranchFeePerMinute	form	decimal?	No
FeeChanges	form	List<SvcFeeChange>	No

**SvcFeeChange** Parameters:
Name	Parameter	Data Type	Required
LocationId	form	Guid	No
OnDate	form	DateTime	No
FromFee	form	decimal	No
ToFee	form	decimal	No

**SvcHourRow** Parameters:
Name	Parameter	Data Type	Required
LocalHour	form	int	No
Served	form	int	No
FeesEarned	form	decimal?	No
CostToStaff	form	decimal?	No

**SvcWorkerRow** Parameters:
Name	Parameter	Data Type	Required
EmployeeId	form	Guid	No
BranchId	form	Guid	No
BranchName	form	string	No
Name	form	string	No
Served	form	int	No
AvgServiceSec	form	double?	No
Utilization	form	double?	No

**SvcAlert** Parameters:
Name	Parameter	Data Type	Required
Level	form	string	No
View	form	string	No
Code	form	string	No
StationId	form	Guid?	No
EmployeeId	form	Guid?	No
BranchId	form	Guid?	No
LineId	form	Guid?	No
Name	form	string	No
OtherLineId	form	Guid?	No
OtherName	form	string	No
StationIds	form	List<Guid>	No
Values	form	Dictionary<string, double>	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
	],
	IncludeScope: False,
	StateCode: String,
	Compare: String
}

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
		}
	],
	Scope: 
	{
		StateCode: String,
		Branches: 
		[
			{
				BranchId: 00000000000000000000000000000000,
				Name: String,
				StateCode: String,
				ZoneCode: String,
				TimeZone: String,
				Windows: 0,
				RecordingSinceUtc: 0001-01-01,
				SessionsSinceUtc: 0001-01-01,
				Metrics: 
				{
					Checkins: 0,
					Walkins: 0,
					Appts: 0,
					Served: 0,
					NoShows: 0,
					ApptNoShows: 0,
					CancelledAtWindow: 0,
					Abandoned: 0,
					Called: 0,
					CalledUp: 0,
					AbandonRate: 0,
					NoShowRate: 0,
					AvgServiceSec: 0,
					MedianServiceSec: 0,
					AvgWaitSec: 0,
					MaxWaitSec: 0,
					AvgWalkUpSec: 0,
					ExpectedServiceSec: 0,
					SignedSec: 0,
					ServingSec: 0,
					PausedSec: 0,
					IdleSec: 0,
					UnstaffedSec: 0,
					Utilization: 0,
					IdleShare: 0,
					PausedShare: 0,
					Sessions: 0,
					OpenDays: 0,
					FeesEarned: 0,
					AvgFee: 0,
					FeesPerStaffedHour: 0,
					ExpectedFeesPerStaffedHour: 0,
					LaborCost: 0,
					LaborPartial: False,
					MissingCostEmployeeIds: 
					[
						00000000000000000000000000000000
					],
					MissingCost: 
					[
						{
							Id: 00000000000000000000000000000000,
							Name: String,
							SignedSec: 0,
							Served: 0
						}
					],
					LaborLocked: False,
					Contribution: 0,
					LostFees: 0,
					LostNoShowFees: 0,
					Mix: 
					{
						00000000000000000000000000000000: 0
					},
					HourlyServed: 
					[
						0
					],
					HourlyFees: 
					[
						0
					],
					HourlyCost: 
					[
						0
					],
					Tints: 
					[
						{
							Field: String,
							Tone: String,
							Reason: String,
							Value: 0,
							Reference: 0,
							BranchValue: 0
						}
					]
				}
			}
		],
		States: 
		[
			{
				StateCode: String,
				StateName: String,
				Branches: 0,
				Metrics: 
				{
					Checkins: 0,
					Walkins: 0,
					Appts: 0,
					Served: 0,
					NoShows: 0,
					ApptNoShows: 0,
					CancelledAtWindow: 0,
					Abandoned: 0,
					Called: 0,
					CalledUp: 0,
					AbandonRate: 0,
					NoShowRate: 0,
					AvgServiceSec: 0,
					MedianServiceSec: 0,
					AvgWaitSec: 0,
					MaxWaitSec: 0,
					AvgWalkUpSec: 0,
					ExpectedServiceSec: 0,
					SignedSec: 0,
					ServingSec: 0,
					PausedSec: 0,
					IdleSec: 0,
					UnstaffedSec: 0,
					Utilization: 0,
					IdleShare: 0,
					PausedShare: 0,
					Sessions: 0,
					OpenDays: 0,
					FeesEarned: 0,
					AvgFee: 0,
					FeesPerStaffedHour: 0,
					ExpectedFeesPerStaffedHour: 0,
					LaborCost: 0,
					LaborPartial: False,
					MissingCostEmployeeIds: 
					[
						00000000000000000000000000000000
					],
					MissingCost: 
					[
						{
							Id: 00000000000000000000000000000000,
							Name: String,
							SignedSec: 0,
							Served: 0
						}
					],
					LaborLocked: False,
					Contribution: 0,
					LostFees: 0,
					LostNoShowFees: 0,
					Mix: 
					{
						00000000000000000000000000000000: 0
					},
					HourlyServed: 
					[
						0
					],
					HourlyFees: 
					[
						0
					],
					HourlyCost: 
					[
						0
					],
					Tints: 
					[
						{
							Field: String,
							Tone: String,
							Reason: String,
							Value: 0,
							Reference: 0,
							BranchValue: 0
						}
					]
				}
			}
		],
		Total: 
		{
			Checkins: 0,
			Walkins: 0,
			Appts: 0,
			Served: 0,
			NoShows: 0,
			ApptNoShows: 0,
			CancelledAtWindow: 0,
			Abandoned: 0,
			Called: 0,
			CalledUp: 0,
			AbandonRate: 0,
			NoShowRate: 0,
			AvgServiceSec: 0,
			MedianServiceSec: 0,
			AvgWaitSec: 0,
			MaxWaitSec: 0,
			AvgWalkUpSec: 0,
			ExpectedServiceSec: 0,
			SignedSec: 0,
			ServingSec: 0,
			PausedSec: 0,
			IdleSec: 0,
			UnstaffedSec: 0,
			Utilization: 0,
			IdleShare: 0,
			PausedShare: 0,
			Sessions: 0,
			OpenDays: 0,
			FeesEarned: 0,
			AvgFee: 0,
			FeesPerStaffedHour: 0,
			ExpectedFeesPerStaffedHour: 0,
			LaborCost: 0,
			LaborPartial: False,
			MissingCostEmployeeIds: 
			[
				00000000000000000000000000000000
			],
			MissingCost: 
			[
				{
					Id: 00000000000000000000000000000000,
					Name: String,
					SignedSec: 0,
					Served: 0
				}
			],
			LaborLocked: False,
			Contribution: 0,
			LostFees: 0,
			LostNoShowFees: 0,
			Mix: 
			{
				00000000000000000000000000000000: 0
			},
			HourlyServed: 
			[
				0
			],
			HourlyFees: 
			[
				0
			],
			HourlyCost: 
			[
				0
			],
			Tints: 
			[
				{
					Field: String,
					Tone: String,
					Reason: String,
					Value: 0,
					Reference: 0,
					BranchValue: 0
				}
			]
		},
		Comparison: 
		{
			Mode: String,
			FromDate: 0001-01-01,
			ToDate: 0001-01-01,
			CutoffMinute: 0,
			HasData: False,
			Metrics: 
			{
				Checkins: 0,
				Walkins: 0,
				Appts: 0,
				Served: 0,
				NoShows: 0,
				ApptNoShows: 0,
				CancelledAtWindow: 0,
				Abandoned: 0,
				Called: 0,
				CalledUp: 0,
				AbandonRate: 0,
				NoShowRate: 0,
				AvgServiceSec: 0,
				MedianServiceSec: 0,
				AvgWaitSec: 0,
				MaxWaitSec: 0,
				AvgWalkUpSec: 0,
				ExpectedServiceSec: 0,
				SignedSec: 0,
				ServingSec: 0,
				PausedSec: 0,
				IdleSec: 0,
				UnstaffedSec: 0,
				Utilization: 0,
				IdleShare: 0,
				PausedShare: 0,
				Sessions: 0,
				OpenDays: 0,
				FeesEarned: 0,
				AvgFee: 0,
				FeesPerStaffedHour: 0,
				ExpectedFeesPerStaffedHour: 0,
				LaborCost: 0,
				LaborPartial: False,
				MissingCostEmployeeIds: 
				[
					00000000000000000000000000000000
				],
				MissingCost: 
				[
					{
						Id: 00000000000000000000000000000000,
						Name: String,
						SignedSec: 0,
						Served: 0
					}
				],
				LaborLocked: False,
				Contribution: 0,
				LostFees: 0,
				LostNoShowFees: 0,
				Mix: 
				{
					00000000000000000000000000000000: 0
				},
				HourlyServed: 
				[
					0
				],
				HourlyFees: 
				[
					0
				],
				HourlyCost: 
				[
					0
				],
				Tints: 
				[
					{
						Field: String,
						Tone: String,
						Reason: String,
						Value: 0,
						Reference: 0,
						BranchValue: 0
					}
				]
			}
		},
		FeesByService: 
		[
			{
				LineId: 00000000000000000000000000000000,
				Name: String,
				Completed: 0,
				AvgServiceSec: 0,
				BranchAvgServiceSec: 0,
				FeesEarned: 0,
				FeeCurrent: 0,
				FeeMin: 0,
				FeeMax: 0,
				FeePerMinute: 0,
				BranchFeePerMinute: 0,
				FeeChanges: 
				[
					{
						LocationId: 00000000000000000000000000000000,
						OnDate: 0001-01-01,
						FromFee: 0,
						ToFee: 0
					}
				]
			}
		],
		ByHour: 
		[
			{
				LocalHour: 0,
				Served: 0,
				FeesEarned: 0,
				CostToStaff: 0
			}
		],
		Workers: 
		[
			{
				EmployeeId: 00000000000000000000000000000000,
				BranchId: 00000000000000000000000000000000,
				BranchName: String,
				Name: String,
				Served: 0,
				AvgServiceSec: 0,
				Utilization: 0
			}
		],
		MultiZone: False,
		MultiState: False,
		RecordingSinceUtc: 0001-01-01,
		SessionsSinceUtc: 0001-01-01,
		Alerts: 
		[
			{
				Level: String,
				View: String,
				Code: String,
				StationId: 00000000000000000000000000000000,
				EmployeeId: 00000000000000000000000000000000,
				BranchId: 00000000000000000000000000000000,
				LineId: 00000000000000000000000000000000,
				Name: String,
				OtherLineId: 00000000000000000000000000000000,
				OtherName: String,
				StationIds: 
				[
					00000000000000000000000000000000
				],
				Values: 
				{
					String: 0
				}
			}
		],
		CanSeeStaff: False,
		CanSeeFinancial: False,
		CanSeePay: False
	}
}