Monitor Error Reporting

Learn how field data errors are reported when remote sensing data is not available for a field.

There are two types of errors that Monitor users can encounter when using the API: technical errors and data errors.

Technical errors are ones used to communicate that an API request has failed, and the reason for the failure. This includes things like an invalid API key used to authenticate requests, user has hit API rate limits, or an internal issue processing the request. Technical errors are not covered in this document, but more information about them can be found in the customer-facing API docs Overview Section.

We'll focus on data errors in this guide. Data errors provide context about the underlying Monitor data including limitations in remote sensing data used to make practice determinations, missing data parameters, or invalid field boundaries provided as part of the request.

How does data error reporting work?

Monitor uses remote-sensing observations to make crop and tillage practice determinations for a field. Fields are observed over a period of time to provide the practice insights.

Missing remote sensing data can impact the ability to make a practice determination for one or more practice. For example, if there is high cloud cover for three months in a region, the crop detection model may not be able to determine the crop type and growing period during that time period. This could also impact other practice determinations such as tillage that rely on the predicted crop type as an input.

Monitor will return as much information as possible about a field, but will report any issues with underlying data or data processing that impact the ability to provide complete practice determinations. Sometimes Monitor will report informational messages as well.

Categories of errors and messages

Missing Data: error class used when underlying remote sensing and/or geospatial data used to make a practice determination is not available for a specific field or time period. These errors may not be actionable by the user, but may be actionable by Regrow. See the error table below for more details.
Data Processing: error class used when there is an issue with the underlying mechanisms for processing data. These errors should be reported to Regrow’s Geospatial engineering team to investigate.
Warnings/Info Messages: class of errors used to inform users of additional context, but are not an actual error. They do not require additional action by the user.

Monitor errors

Error schema

Monitor field results contain an error array, with information about data or processing issues. The array will contain one object for each distinct error. Each error object will include:

a standard error code for like errors
text to describe the error
a metadata dictionary that includes additional context on the affected practice, pulling out key pieces of information from the error test that are machine-readable

Error object schema:

code: string, an error code constant with a categorical prefix to classify error types
text: string, a human readable description of the error
metadata: object, a machine readable dictionary of data points to supplement the error code. The fields in the metadata object are specific to the error code (see the error codes table below for a list of metadata fields returned for each error code).

For example:

errors = [
      {
        "code": "PW01",
        "text": "Harvest date 2022-09-18 for Corn has been set using regional crop specific data",
        "metadata": {
          "date_set": "2022-09-18",
          "crop_type": "Corn",
          "date_type": "harvest"
        }
      }
    ]

Error codes

The following table contains a list of errors and the associated codes. Errors that begin with M are Missing Data errors, Errors that begin with P are Data Processing errors, and errors that begin with PW indicate a warning that default plant or harvest dates are used in the response. UnknownExceptions may also be thrown for errors that are not recognized as an existing type.

Error code	Error name	Metadata fields	Description	What action is needed?
MD01	MissingFieldStatsYears	missing_years	CropID data (crop & P/H dates) is not available for this field and year. Tillage and cover crop data is unavailable as well due to the dependency on CropID.	Reach out to Regrow Support at support@regrow.ag for assistance
MD02	ProductNotFound	product_type start_date end_date	A needed data product used as input for calculating field stats was not found.	Reach out to Regrow Support at support@regrow.ag for assistance
MD03	PracticeParametersNotFound	geohash start_date end_date	Practice parameters for one or more geohash/year combinations was not found.	Reach out to Regrow Support at support@regrow.ag for assistance
MD04	MissingPHRemoteSensingData	crop_type start_date end_date before_after	Plant Harvest data for a crop type during a specific period was not found. This error is generally continuable but may make it impossible to determine green cover and tillage.	FYI message. No action needed by user. Some practices may not be reported due to limitations in remote sensing data.
MD05	NoCropTypeForCycle	crop_cycle start_date end_date	Unable to determine a crop type for a crop cycle during a specific time period. This error is continuable.	FYI message. No action needed by user. Some practices may not be reported due to limitations in remote sensing data.
MD06	CropTranslation	crop_id_name	No Regrow crop name could be found for a CropID crop name in the Defaults Service.	Reach out to Regrow Support at support@regrow.ag for assistance
MD07	MissingFieldStatsData	missing_years	Crop, tillage and/or cover crop practice data is unavailable due to a lack of usable remote sensing data. This is expected for a small portion of fields.	FYI message. Generally, no action is needed by user, but user may want to double check that the time period of the request is within Monitor’s supported tome period. Some practices may not be reported due to limitations in remote sensing data.
MD08	UnsupportedMissingFieldStatsYears	missing_years	Data cannot be provided for a requested year(s) because the request time period is outside of the supported time period by Monitor.	Informative message. No action is required, but you can optionally re-submit the request with an adjusted request time period.
MD09	UnknownMissingFieldStatsYears	missing_years	Crop, tillage and/or cover crop practice data is unavailable due to a lack of usable remote sensing data. This is unexpected.	Reach out to Regrow Support at support@regrow.ag for resolution.
PE02	InvalidBoundary	N/A	A boundary id was provided that does not exist.	Users should re-submit their request to Monitor with their field formatted in correct geoJSON (note - it’s worth checking that there aren’t typos/extra characters/missing digits in the boundary ids before re-submitting as geojson, as these are common causes of this error). A Boundary ID will be provided that can be used in subsequent requests for that field.
PE03	UnsupportedProduct	product_type version	No data product of an acceptable version was found in the Data Catalog.	Reach out to Regrow Support at support@regrow.ag for assistance
PE04	DataIntegrity	N/A	The raw data products used to calculate field statistics contain invalid or unusable data.	Reach out to Regrow Support at support@regrow.ag for assistance
PE05	MultiModal	N/A	Two or more modes were found for the crop cycles band of a raster.	Reach out to Regrow Support at support@regrow.ag for assistance
PE06	RasterBand	N/A	Data in some of the bands of a raster was found to be invalid or unusable.	Reach out to Regrow Support at support@regrow.ag for assistance
PE07	DataCatalog	N/A	The metadata of a raster was found to be invalid or unusable.	Reach out to Regrow Support at support@regrow.ag for assistance
PE08	DataProductValidation	validation_error data_product_info	Metadata returned from the Data Catalog was not a valid instance of a data product's metadata schema.	Reach out to Regrow Support at support@regrow.ag for assistance
PE09	InvalidCropHistory	N/A	Monitor is not able to provide a valid crop history due to the field, due to anomalous planting and harvest dates for at least two crop cycles. “Unable to generate valid crop history from: "	FYI message. No action needed by user. Monitor won’t return field data for a portion, or all of the field.
PW01	RegionalCropSpecificData	data_type data_set crop_type	A warning issued when a regional default plant/harvest date is supplied instead of a date determined through a raster data product.	FYI message. No action needed by user.