deprecated

Climate - new Net Zero criteria 5 metrics in async API

Summary (What?)

A new universe API is created for the Climate Alignment - Net Zero product which forces to request the specific metrics to be exported, ensuring that our clients can start ingesting new metrics like the NZ Criteria-5 metrics at their own pace.

As a consequence, we are deprecating the previous Net Zero endpoint that didn’t enforce the explicit request of specific metrics when generating the dataset.

Business impact (Why?)

The new endpoint is able to deliver any of the Climate Alignment - Net Zero metrics, including the new Criteria-5 metrics and the upcoming Criteria-6 metrics, while allowing flexibility in the client's side to integrate the new metrics whenever they want.

The deprecated endpoint is not capable of adding new metrics to the response, given that we could trigger a breaking change in the client’s side, as it currently returns all the available metrics for the whole Climate Alignment - Net Zero product. The legacy approach may seem easier for clients to integrate but it creates issues whenever Clarity AI is extending product’s scope, such as adding new metrics.

Modules and Endpoints impacted (Where?)

List of endpoints by module impacted by this release:

ModuleEndpointsAction (addition/removal/change)
ClimatePOST /public/organizations/climate-alignment/net-zero/metric-by-id/asyncAddition
ClimatePOST /public/organizations/net-zero/metric-by-id/asyncDeprecation

Deprecated Endpoints or Features (How?)

  1. Net Zero organizations feed endpoint: deprecated endpoint https://developer.clarity.ai/reference/asyncjoborganizationmetricsbypermid replaced by https://developer.clarity.ai/reference/asyncjobnzorganizationreceivingmetricsandpermid

Transition timeline (When?)

EventDescriptionDate
ReleaseNEW POST /public/organizations/climate-alignment/net-zero/metric-by-id/async launched05/Aug/2024
AnnouncementThis release notes23/Aug/2024
End of SupportNo more support provided for LEGACY POST /public/organizations/net-zero/metric-by-id/async07/Feb/2025
DecommissioningLEGACY POST /public/organizations/net-zero/metric-by-id/async28/Feb/2025