Changelog

This changelog lists all additions and updates to the Gardin Services API, in chronological order.

Users can subscribe to updates via the RSS feed (https://developers.gardin.ag/changelog/rss.xml)

2.0.1 (11^th September 2025)

Query service

• Fix to ensure that deviceId filter and data__deviceId column in result sets remain available for ChF data queries (type="chf").

2.0.0 (11^th August 2025) Major version

V1 deprecation

Version 1 (v1) of the Gardin Services API was retired on 11^th September 2025 and is now unavailable. Version 2 (v2) is now the only available endpoint.

General

• We have updated our API naming conventions for improved clarity:

1. The "Gardin API" is now called "Gardin Services API".
2. The "Query API" becomes "Query service" (part of Gardin Services API).
3. The "Sensor Management API" becomes "Sensor Management service" (part of Gardin Services API).
4. The "Alert Notification API" remains unchanged.

Query service

• Breaking change The data__deviceId column has been removed from result sets for queries targeting indices data (i.e. type="indices") - See: GET /query/:queryId/result/download endpoint documentation. This neccessary change supports multi-sensor monitoring of individual control areas. The data__deviceId column remains available for CHF-type data requests.
• Breaking change The sensors filter is no longer supported in Query service requests due as it is no longer applicable following the removal of device from result sets - See: POST /query endpoint documentation.
• Breaking change The controlAreas filter has been removed, and has been superceded by the controlAreaPathNames filter.

• A new controlAreaPathName column is now available in result sets for both indices and CHF-type data requests, providing hierarchical mapping of measurement data to customer facility layout using a hash-delimited format (e.g., "Gardin#Glasshouse 1#Zone A#Small Bench"). See POST /query endpoint documentation for more information.

• We have introduced a new controlAreaPathNames filter which provides enhanced flexibility and performnce when wishing to limit query results to certain control areas and/or parent locations. This supercedes the now-deprecated controlAreas filter. See: POST /query endpoint documentation.

1.7.0 (7^th July 2025)

Query API

• Automatic interpolation of periods with missing values within indices-type result sets is now supported and enabled by default. Interpolated records can be identified through the new data_isFilled column (where TRUE means an interpolated value has been used, and FALSE means interpolation was not required). Users can disable the inclusion of interpolated values via the new includeFilled filter property. See POST /query endpoint documentation for more information.
• Introduced ISO-8601 compliant timestamp format for result sets (data__timestampIso column). See GET /query/:queryId/result/download endpoint documentation for more information.

1.6.1 (23^rd April 2025)

Query API

• Fix to ensure job_id filter is correctly applied in all expected situations.

1.6.0 (4^th February 2025)

Query API

• PPFD (Photosynthetic Photon Flux Density) index is now available to download via Query API. See documentation for the POST /query endpoint for more information.
• Performance improvements through automatic exclusion of internal-diagnostics measurements from result sets.

1.5.0 (23^rd October 2024)

Query API

• DPI (Daily photosythesis integral) and DLI (Daily light integral) indices are now available to download via Query API for selected license plans. See documentation for the POST /query endpoint for more information.

1.4.0 (3^rd October 2024)

Query API

• Endpoint removed The GET /query/:queryId/result endpoint has been retired and is no longer available. Users should use the GET /query/:queryId/result/download endpoint, which supports single request, large-volume downloads.

1.3.0 (19^th August 2024)

Query API

• Deprecation Notice The GET /query/:queryId/result endpoint has been marked as deprecated and is scheduled to be retired. Users should use the GET /query/:queryId/result/download endpoint, which supports single request, large-volume downloads. Update (3^rd September 2024): This endpoint will be permanently unavailable after 3rd October 2024.

• Index values in result sets now support the neccessary 1dp precision.

• Issue on POST /query endpoint preventing users from being able to provide an array of values for the controlArea filter has been fixed.

1.2.0 (31^st May 2024)

Query API

• Query result sets can now be downloaded via a single request as a CSV export (GET /query/:queryId/result/download endpoint).
• Scheduled and/or running queries can now be cancelled via the PATCH /query/:queryId/cancel endpoint.
• Additional query filters are now available: jobId, isDaytime.
• Users can now specify which columns they would like to include in query result sets via the selectColumns filter.

1.1.0 (9^th April 2024)

Query API

• First release of Query API.

1.0.0 (19^th February 2024) Major version

Login API

• First release of Login API.

Sensor Management API

• First release of Sensor Management API.

Alert Notification API

• First release of Alert Notification API.