Skip to main content

Endpoint Comparison

Compare v1 and v2 endpoints to identify migration requirements and available functionality.

Available in v2

These endpoints are currently available and provide equivalent or enhanced functionality compared to v1:

🟢 Devices

v1 Endpointv2 EquivalentStatus & Notes
N/AGET /devicesNew in v2 - List all devices with metadata
N/AGET /devices/{deviceuuid}/consumption/{metrictype}New in v2 - Get device-level consumption data
N/APOST /devices/{deviceuuid}/scheduleNew in v2 - Send device control commands

🟢 Spaces

v1 Endpointv2 EquivalentStatus & Notes
N/AGET /spacesNew in v2 - List all spaces with metadata
GET /spaces/details/{spaceId}GET /spaces/{spaceuuid}/overviewAvailable - Enhanced space metadata
GET /spaces/utilities/{spaceId}GET /spaces/{spaceuuid}/aggregate/{metrictype}/hourlyAvailable - Current utilities data with configurable granularity
GET /spaces/utilities/{spaceId}/historyGET /spaces/{spaceuuid}/aggregate/{metrictype}/dailyAvailable - Historical utilities with flexible time ranges
GET /spaces/utilities/{spaceId}/monthlyGET /spaces/{spaceuuid}/aggregate/{metrictype}/dailyAvailable - Monthly aggregation available
GET /spaces/multiSensor/{spaceId}GET /spaces/{spaceuuid}/aggregate/{metrictype}/hourlyAvailable - Current environmental data
GET /spaces/multiSensor/{spaceId}/historyGET /spaces/{spaceuuid}/aggregate/{metrictype}/dailyAvailable - Historical environmental data
GET /spaces/performance/{spaceId}GET /spaces/{spaceuuid}/aggregate/{metrictype}/dailyAvailable - Space performance metrics for the month
GET /spaces/utilities/performance/{spaceId}GET /spaces/{spaceuuid}/aggregate/{metrictype}/dailyAvailable - Utilities performance for the month

Future Enhancements

These v1 endpoints will be superseded by enhanced functionality in future v2 releases:

🟠 Occupancy Data (People Counting)

  • GET /buildings/occupancy/{buildingId} - Current building occupancy
  • GET /buildings/occupancy/{buildingId}/history - Historical building occupancy
  • GET /sites/occupancy/{siteId} - Current site occupancy
  • GET /sites/occupancy/{siteId}/history - Historical site occupancy

🟠 Performance & Analytics

  • GET /spaces/utilities/rank/{spaceId} - Space ranking
  • GET /spaces/tip/{spaceId} - Energy saving tips

Not Available in v2

These v1 endpoints are scheduled for retirement and will not be implemented in v2 due to low partner adoption:

🔴 Asset Management

  • GET /tenant/logo - Get tenant logo
  • GET /building/image/{buildingId} - Get building images

🔴 Weather Data

  • GET /buildings/weather/{buildingId} - Building weather data
  • GET /sites/weather/{siteId} - Site weather data

🔴 Carbon Data

  • GET /buildings/carbonIntensity/{buildingId} - Building carbon intensity
  • GET /buildings/carbonIntensity/{buildingId}/carbonGenerationMix - Building carbon mix
  • GET /sites/carbonIntensity/{siteId} - Site carbon intensity
  • GET /sites/carbonIntensity/{siteId}/carbonGenerationMix - Site carbon mix
  • GET /spaces/carbonEmissions/{spaceId} - Space carbon emissions

Migration Planning

Use this comparison to plan your migration:

  • 🟢 Available endpoints can be migrated immediately
  • 🔴 Retired endpoints require alternative solutions or removal
  • 🟠 Future endpoints may be worth waiting for enhanced replacements

Contact your technical contact early in migration planning if your application depends on retired or future endpoints.