Survey History Entities · Customer Documentation Portal

Overview

The Price collection consists of the different types of survey history recorded by the kalibrate pricing system survey utilities and Kalibrate Pricing.

Competitor Survey Adjustment

Name	Description
Entity Description	Attributes of the core competitor survey adjustment entity
Source Schema	dbo
Source Table	PNCompetitorSurveyAdjustment
Destination Collection(Endpoint)	SurveyHistory
Entity Type	CompetitorSurveyAdjustment
Entity Variant	Common

Competitor Survey Adjustment Attribute Details

Field	Reference Entity	Field Description	Format	Max Bytes
Adjustment		Unique identifier for adjustment record	int	4
Site	Site	Reference to Own Site	unidue identifier	16
StartDate		startdate of adjustment	datetime	8
EndDate		End date of adjustment	datetime	8

Competitor Survey Target

Name	Description
Entity Description	Attributes of the core competitor survey target entity
Source Schema	dbo
Source Table	PNCompetitorSurveyTarget
Destination Collection(Endpoint)	SurveyHistory
Entity Type	CompetitorSurveyTarget
Entity Variant	Common

Competitor Survey Target Attribute Details

Field	Reference Entity	Field Description	Format	Max Bytes
OwnSite		legacy internal reference to Own Site Competitor	uniqueidentifier	16
CompetitorSite		legacy internal reference to a Competitor Site	uniqueidentifier	16
Date		Date on which the period applies	date	3
WeekdaySerialNumber		Number that identifies the day of the week. Values go from 1 to 7, where 1 is Monday and 7 is Sunday	tinyint	1
PeriodSerialNumber		Number that identifies the period within the day. Values go from 1 to 24	tinyint	1
StartTime		Start time for the period	smalldatetime	4
EndTime		End time for the period	smalldatetime	4
Target		Indicates whether a competitor survey is required during this period	bit	1
ReportGroupUID		ID of the reporting group for the period	uniqueidentifier	16
CompetitorSurveyTargetProductID		SystemGenerated ID. NOt used for reporting	int	1
CompetitorProductUID	Product	Unique identifier for the product being surveyed	uniqueidentifier	16
IncludeThisProduct		True or False flag to indicate if the product should be surveyed	bit	1

kMobile Competitor Site

Name	Description
Entity Description	Attributes of the core kCompetitorSite entity
Source Schema	dbo
Source Table	kCompetitorSite
Destination Collection(Endpoint)	SurveyHistory
Entity Type	kCompetitorSite
Entity Variant	Common

kMobile Competitor Site Attribute Details

Field	Field Description	Format	Max Bytes
CompetitorSiteID	Internal unique identifier	int	4
CompetitorSite	Internal unique identifier	uniqueidentifier	16
Image	The photo taken	varbinary	2000
ImageName	The name of the photo	nvarchar	2048
ImportCode	TBC	nvarchar	200

kMobile Survey

Name	Description
Entity Description	Attributes of the core kSurvey entity
Source Schema	dbo
Source Table	kSurvey
Destination Collection(Endpoint)	SurveyHistory
Entity Type	kSurvey
Entity Variant	Common

kMobile Survey Attribute Details

Field	Reference Entity	Field Description	Format	Max Bytes
SurveyId		Internal unique identifier	uniqueidentifier	16
Date		Time when the survey was submitted	datetime	8
Site	Site	Site that was the target of the survey	uniqueidentifier	16
SiteType		Determines whether the survey relates to OWN or COMPETITOR site	varchar	15
Submitter		Login ID of the person who provided the survey	uniqueidentifier	16
Reviewer		Login ID of the person who approved the survey, typically the same as the Submitter	uniqueidentifier	16
ReviewDate		Time when the survey was reviewed	datetime	8
Latitude		The latitude recorded when the survey was submitted	float	8
Longitude		The longitude recorded when the survey was submitted	float	8
Reviewed		Flag to determine if a price has been reviewed	bit	1

kMobile Competitor Survey Products

Name	Description
Entity Description	Attributes of the core kCompetitorSurveyProducts entity
Source Schema	dbo
Source Table	kCompetitorSurveyproducts
Destination Collection(Endpoint)	SurveyHistory
Entity Type	kCompetitorSurveyProducts
Entity Variant	Common

kMobile Competitor Survey Products Attribute Details

Field	Reference Entity	Field Description	Format	Max Bytes
ProductSurveyID		Internal unique identifier	bigint	8
SiteSurveyID		Internal unique identifier	bigint	8
CompetitorProduct	Product	Product associated with surveyed price	uniqueidentifier	16
Price		Submitted survey price for the product	money	8
Status		Product Status indicator	int	4
Processed		TBC	bit	1
ReviewDate		Time when the survey for the product was reviewed	datetime	8
Reviewer		Login ID of the person who approved the survey, typically the same as the Submitter	uniqueidentifier	16
Amended		ClientTime	datetime	8

kMobile Survey Sites

Name	Description
Entity Description	Attributes of the core kSurveySites entity
Source Schema	dbo
Source Table	kSurveySites
Destination Collection(Endpoint)	SurveyHistory
Entity Type	kSurveySites
Entity Variant	Common

kMobile Survey Sites Attribute Details

Field	Reference Entity	Field Description	Format	Max Bytes
SiteSurveyID		Internal unique identifier	bigint	8
SurveyID		Internal unique identifier	bigint	8
Site	Site	Competitor Site that was the target of the survey	uniqueidentifier	16
AssociatedOwnSite	Site	Own site to which the competitor is associated	uniqueidentifier	16
Reviewer		Login ID of the person who approved the survey, typically the same as the Submitter	uniqueidentifier	16
ReviewDate		Time when the survey was reviewed	datetime	8
Reviewed		Flag to determine if a price has been reviewed	bit	1

Survey Compliance Summary

Name	Description
Entity Description	Attributes of the core SurveyComplianceSummary entity
Source Schema	dw
Source Table	FactSurveyComplianceSummary
Destination Collection(Endpoint)	SurveyHistory
Entity Type	SurveyComplianceSummary
Entity Variant	Common

Survey Compliance Summary Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
SurveyComplianceSummaryID		Internal unique identifier	bigint	8
OwnSite	Site	Embedded reference of the Own Site	uniqueidentifier	16
Date		Survey Compliance Date	datetime	8
StartTime		Start time for the period	smalldatetime	4
EndTime		End time for the period	smalldatetime	4
ReportGroupID		Internal unique identifier for Report Group	bit	4
ExpectedPriceCount		Total of expected survey prices	int	4
ActualPriceCount		Total of actual survey prices	int	4
ExpectedSiteCount		Expected site count during survey window	int	4
ActualSiteCount		Actual site count during survey window	int	4
TargetMet		Target met	bit	1
Adjustment		Adjustment	int	4
AdjustmentDate		Survey Compliance Summary adjustment date	datetime	8

Survey Compliance Summary Daily

This endpoint is scheduled for deprecation in a future version of the API. It is recommended to transition to the Survey Compliance Summary endpoint, which provides enhanced functionality and support going forward.

Name	Description
Entity Description	Attributes of the core SurveyComplianceSummaryDaily entity
Source Schema	dw
Source Table	FactSurveyComplianceSummaryDaily
Destination Collection(Endpoint)	SurveyHistory
Entity Type	SurveyComplianceSummaryDaily
Entity Variant	Common

Survey Compliance Summary Daily Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
SurveyComplianceSummaryDailyID		Internal unique identifier	bigint	8
OwnSite	Site	Embedded reference of the Own Site	uniqueidentifier	16
Date		Survey Compliance Date	datetime	8
ReportGroupID		Internal unique identifier for Report Group	bit	4
ExpectedPriceCount		Total of expected survey prices	int	4
ActualPriceCount		Total of actual survey prices	int	4
ExpectedSurveyWindowCount		Expected price count during survey window	int	4
ActualSurveyWindowCount		Actual price count during survey window	int	4
OusideSurveyWindowCount		Count of prices submitted outside the survey window	int	4
ExpectedSiteCount		Expected site count during survey window	int	4
ActualSiteCount		Actual site count during survey window	int	4
TargetMet		Target Metrics	int	4