Customer Documentation Portal
  • Docs

›Data Model

Getting Started

  • Welcome
  • Environments
  • Onboarding

Documentation

  • Introduction
  • Data Organisation
  • Authentication
  • Query Language
  • Data Model

    • Data Model
    • Entities
    • Price
    • Price Request
    • Product
    • Product Group
    • Reference
    • Site
    • Survey History
    • Volume
  • Import Endpoints

Tutorials

  • Welcome
  • Excel
  • Authenticating

Kalibrate Data API Entity List

Index of entities

The following tables list all of the available entites (endpoints) in the Data API, the collection to which they belong, their entity type and entity variant. Grouped by Collection.


Price

EntityEntity TypeEntity VariantCollection
Competitor PricePriceCompetitorPrice
Competitor Price DailyPriceCompetitorPriceDailyPrice
Cost PricePriceCostPrice
Dealer PricePriceDealerPrice
Dealer Trade Area PricePriceDTAPrice
Notional Street PricePriceNotionalStreetPrice
OPIS Competitor PricePriceOPISCompetitorPrice
OPIS Own PricePriceOPISOwnPrice
Own PricePriceOwnPrice
Own Price DailyPriceOwnPriceDailyPrice
Proposed PricePriceProposedPrice
SOE PricePriceSOEPrice

Price Request

EntityEntity TypeEntity VariantCollection
EventEventCommonPrice Request
General Price ChangeGeneralPriceChangeCommonPrice Request
Master Price RequestMasterPriceRequestCommonPrice Request
Price RequestPrice RequestCommonPrice Request
Price Request ReviewPriceRequestReviewCommonPrice Request
Proposed Price AuditProposedPriceAuditCommonPrice Request
RestorationRestorationCommonPrice Request

Product

EntityEntity TypeEntity VariantCollection
Competitor ProductProductCompetitorProduct
Global ProductProductGlobalProduct
Own ProductProductOwnProduct

Product Group

EntityEntity TypeEntity VariantCollection
Global Product GroupProduct GroupGlobalProduct Group
Own Product GroupProduct GroupOwnProduct Group

Reference

EntityEntity TypeEntity VariantCollection
AlternateImportcodeAlternateImportcodeCommonReference
AreaAreaCommonReference
BrandBrandCommonReference
Channel Of TradeChannelOfTradeCommonReference
Competitor GroupCompetitorGroupCommonReference
Competitor PriorityCompetitorPriorityCommonReference
ConfigConfigCommonReference
Contract TypeContractTypeCommonReference
Contract ValueContractValueCommonReference
Contract Value TypeContractValueTypeCommonReference
Cost BreakdownCostBreakdownCommonReference
Cost TypeCostTypeCommonReference
Cross EffectCrossEffectCommonReference
Data ChannelDataChannelCommonReference
Data TypeDataTypeCommonReference
Dealer Trust CategoryDealerTrustCategoryCommonReference
Entity Pricing ProfileEntityPricingProfileCommonReference
Event TemplateEventTemplateCommonReference
Event TypeEventTypeCommonReference
Extended PropertyExtendedPropertyCommonReference
Extended Property GroupExtendedPropertyGroupCommonReference
Extended Property OptionExtendedPropertyOptionCommonReference
Extended Property TypeExtendedPropertyTypeCommonReference
Extended PropertyExtendedPropertyCommonReference
Log AlphaLogAlphaCommonReference
Margin Allocation MethodMarginAllocationMethodCommonReference
Market Share DataMarketShareDataCommonReference
NetworkNetworkCommonReference
Price Point SetPricePointSetCommonReference
Price Request TypePriceRequestTypeCommonReference
Pricing Period TemplatePricingPeriodTemplateCommonReference
Pricing Profile RulePricingProfileRuleCommonReference
Pricing Period TypePricingPeriodTypeCommonReference
Pricing ProfilePricingProfileCommonReference
PriorityPriorityCommonReference
RuleRuleCommonReference
Rule Property ValueRulePropertyValueCommonReference
Rule TypeRuleTypeCommonReference
Sales ImpactSalesImpactCommonReference
Sales TypeSalesTypeCommonReference
Site Stock TypeSiteStockTypeCommonReference
StoreSalesStoreSalesCommonReference
StoreSalesTypeStoreSalesTypeCommonReference
Strategy NoteStrategyNoteCommonReference
System TypeSystemTypeCommonReference
TerminalTerminalCommonReference
Time ZoneTimeZoneCommonReference
UserUserCommonReference

Site

EntityEntity TypeEntity VariantCollection
Competitor SiteSiteCompetitorSite
Own SiteSiteOwnSite
Own Site CompetitorOwnSiteCompetitorCommonSite

Survey History

EntityEntity TypeEntity VariantCollection
Competitor Survey AdjustmentCompetitorSurveyAdjustmentCommonSurvey History
Competitor Survey TargetCompetitorSurveyTargetCommonSurvey History
Kmobile Competitor SiteCompetitorSiteCommonSurvey History
KMobile SurveyKMobileSurveyCommonSurvey History
Kmobile Survey SitesKmobileSurveySitesCommonSurvey History
Survey Compliance SummarySurveyComplianceSummaryCommonSurvey History
Survey Compliance Summary DailySurveyComplianceSummaryDailyCommonSurvey History

Volume

EntityEntity TypeEntity VariantCollection
Daily Plan VolumeVolumePlanVolumeDailyVolume
Daily Sales VolumeVolumeSalesVolumeDailyVolume
Delivery VolumeVolumeDeliveryVolume
Forecast VolumeVolumeForecastVolume
Plan VolumeVolumePlanVolume
Projected VolumeVolumeProjectedVolume
← Data ModelPrice →
  • Index of entities
  • Price
  • Price Request
  • Product
  • Product Group
  • Reference
  • Site
  • Survey History
  • Volume
Copyright © 2025 Kalibrate Technologies Limited