Plant Health

Introduction

The Plant Health service is a tool that allows growers to assess the health and vigor of their crops. This service makes use of a common vegetation index, the Normalized Difference Vegetation Index, or NDVI.

NOTE:   The processPlantHealth() mutation and retrievePlantHealth() query are only shortcuts to the processVegetationIndices() mutation and retrieveVegetationIndices() query. The Plant Health service endpoints call the VegetationIndices service endpoints with an indexType of NDVI.

Processing Plant Health Images

You can use the processPlantHealth() mutation to process the plant health images. The endpoint can also be used for processing daily plant health estimates, for more information on daily estimation images, please refer to our documentation.

Usage

The processPlantHealth() mutation is used to process plant health images based on the satellite data. The endpoint requires three arguments:

• polygonId*: The polygonId is the unique ID generated when you register/create a polygon in the API. You use this unique identifier to specify the plot you want to analyse.
• startDate*: This date specifies the start of the date range that you want to process.
• endDate*: This date specifies the end of the date range that you want to process.
• dailyEstimates: This optional parameter specificies if the daily estimates should be processed, or if the regular images based on the satellite imagery should be processed. For daily estimation images, it should be set to true.

The endpoint only returns the status of the request itself, with the requestId. The request can be tracked using the requestId using the retrieveRequestDetails() endpoint. For more information on monitoring requests, please refer to our monitoring documentation.

Example

mutation {
  processPlantHealth(
    polygonId:         "PolygonId"
    startDate:         "2024-01-01"
    endDate:           "2024-05-01"
    dailyEstimates:    false
  )
  {
    IsSuccess
    Message
    Status
    Result {
      requestId
    }
  }
}

Retrieving Plant Health Images

You can use the retrievePlantHealth() mutation to retrieve the plant health images. The endpoint can also be used for retrieving daily plant health estimates, for more information on daily estimation images, please refer to our documentation.

Usage

The retrievePlantHealth() query is used to retrieve processed plant health images based on the satellite data. The endpoint requires three arguments:

• polygonId*: The polygonId is the unique ID generated when you register/create a polygon in the API. You use this unique identifier to specify the plot you want to analyse.
• startDate*: This date specifies the start of the date range that you want to retrieve.
• endDate*: This date specifies the end of the date range that you want to retrieve.
• dailyEstimates: This optional parameter specificies if the daily estimates should be retrieved, or if the regular images based on the satellite imagery should be retrieved. For daily estimation images, it should be set to true.

Example

mutation {
  retrievePlantHealth(
    polygonId:         "PolygonId"
    startDate:         "2024-01-01"
    endDate:           "2024-05-01"
    dailyEstimates:    false
  )
  {
    IsSuccess
    Message
    Status
    Result {
      colorlegend
      tif
      png
      json
    }
  }
}

Please refer to the Schema Documentation in the API Playground for more information.