Growth

Crop Growth & Health API

Iteris’ Crop Growth & Health API includes crop-specific growth models, including Crop Growth Model Feedback, Crop Harvest Modeling, and Crop Nutrient (Nitrogen) Decision Support.

Crop Growth

last updated 10/15/19

The growth models combine user-provided information with the ClearAg field weather and soil data to provide past, current, and projected plant growth stage information specific to a particular crop planted on a specific field.

ClearAg growth models can be functionally categorized into two types:

  • Predictive Growth Models - Group of models which utilize user inputs, such as planting date and variety, to generate predicted growth stage dates. User feedback can then be utilized to adjust the predicted growth stages for selected crops.

  • Prescribed Growth Models - Group of models which require the user to enter typical growth stage dates to properly model the stage dependent vegetative and root zone characteristics. These models are used in conjunction with other ClearAg services such as Irrigation and Nutrient decision support. User feedback can be utilized to correct the estimated growth stage dates in-season.

  • Vegetation Growth Model - Satellite derived vegetation model which predicts the seasonal change in vegetation fraction for any region globally based on historical data. The vegetation data is then used to predict soil conditions in the absence of predictive or prescribed growth models.

The required parameters will vary depending on whether coordinates are provided or Accounts API integration is used. For clients not using the Accounts API, required and optional parameters are listed under the “location-based” column within the Request Parameters tables. For required and optional parameters when utilizing the Accounts API, please refer to the information contained in the “Accounts API Integration” column. When utilizing the Accounts API, field, growth, activity, and feedback information present in the system will be used where necessary. The Accounts API integration will automatically pre-populate client data where applicable.

Additional information is provided in the Accounts API.

For those not currently using the Accounts API, please contact your Iteris account representative for details.

Please note that API responses are currently only provided in English.

Iteris requires the use of https when working within the ClearAg APIs.

Additional API information is available in the Appendix.

Predictive Growth Models

Predictive Growth Models are a group of models which utilize user inputs, such as planting date and variety, to generate predicted growth stage dates. User feedback can then be utilized to adjust the predicted growth stages for selected crops.

Barley

Barley Growth Creation - v1.0

This endpoint allows users to create a spring barley growth on an existing field. Users adding a spring barley growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Barley Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"spring barley",
    "plant_type":50,
    "relative_maturity":"medium",
    "zone_map_id":null
}

Barley Growth Modify - v1.0

This endpoint allows a user to modify an existing spring barley growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Barley Growth Delete - v1.0

This endpoint allows users to delete a spring barley growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Barley Growth - v1.1

Leveraging Iteris' spring barley growth stage model, the Barley Growth endpoint allows users to model the maturation and development of spring barley crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/barley/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/barley/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-17":{
                    "agdd":2563.0,
                    "air_temp_max":82.0,
                    "air_temp_min":63.0,
                    "gdd":40.5,
                    "last_stage":"13.0",
                    "new_stage":"15.0"
                },...
            },
            "harvest_window":{
                "end":"2016-08-17",
                "start":"2016-07-27"
            }
        }
    },
    "stage_descriptions":{
        "15.0":{
            "advisor":"Harvest",
            "description":"Dry weight of the kernels stops increasing.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"This stage is between Hard Dough (left) and Harvest Ripe (right)",
                    "url":".../Physiological_maturity.png"
                },...
            ],
            "name":"15.0 - Physiological Maturity",
            "order":"16"
        },...
    }
}

Barley Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/add/abc-123/1535760000/15.0?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Barley Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":50,
            "start_override":false,
            "stage":"15.0"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":50
    },...
]

Barley Growth Modify Feedback - v1.0

The Barley Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=15.0
Example Response
true

Barley Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Barley Growth with GDD Envelope - v1.1

The Barley Growth with GDD Envelope service provides spring barley growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/barley/growth/gdd_envelope?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the minimum AGDD value was observed.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/barley/growth/gdd_envelope?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-17":{
                    "agdd":2563.0,
                    "agdd_envelope_max":2750.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2450.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":82.0,
                    "air_temp_min":63.0,
                    "gdd":40.5,
                    "last_stage":"13.0",
                    "new_stage":"15.0"
                },...
            },
            "harvest_window":{
                "end":"2016-08-17",
                "start":"2016-07-27"
            }
        }
    },
    "stage_descriptions":{
        "15.0":{
            "advisor":"Harvest",
            "description":"Dry weight of the kernels stops increasing.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"This stage is between Hard Dough (left) and Harvest Ripe (right)",
                    "url":".../Physiological_maturity.png"
                },...
            ],
            "name":"15.0 - Physiological Maturity",
            "order":"16"
        },...
    }
}

Bent Turfgrass

Bent Turfgrass Growth Creation - v1.0

This endpoint allows users to create a bent turfgrass growth on an existing field. Users adding a bent turfgrass growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_date={string}&variety={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

start_date

string

yes

Start date of the model, formatted either as a date string (YYYY-MM-DD) or a Unix timestamp. (Note that this is stored only as a timestamp in the database.)

variety

string

yes

Subclass of bent turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&start_date=1525132800&variety=generic
Example Response
abc-def

Bent Turfgrass Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

start_date

Start date of the model in the form of a Unix timestamp.

variety

Subclass of bent turfgrass. Currently, only "generic" is supported.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_name":"bent turfgrass",
    "plant_type":89,
    "start_date":1525132800,
    "variety":"generic",
    "zone_map_id":null
}

Bent Turfgrass Growth Modify - v1.0

This endpoint allows a user to modify an existing bent turfgrass growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_date={string}&variety={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

start_date

string

no

Start date of the model, formatted either as a date string (YYYY-MM-DD) or a Unix timestamp. (Note that this is stored only as a timestamp in the database.)

variety

string

no

Subclass of bent turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Bent Turfgrass Growth Delete - v1.0

This endpoint allows users to delete a bent turfgrass growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Bent Turfgrass Growth - v1.0

The Bent Turfgrass Growth endpoint allows users to simulate the dormancy of bent turfgrass and determine when it is expected to be fully dormant, fully active, and in a transition phase between these two.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&start_date={string}&variety={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

start_date

string

yes

 — 

Start date of the model, formatted either as a date string (YYYY-MM-DD) or a Unix timestamp.

variety

string

yes

 — 

Subclass of bent turfgrass. Currently, only "generic" is supported.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Note that due to the perennial nature of turfgrass, the same stages can be reached multiple times in the simulation.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bent/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-05-01":{
                    "air_temp_max":66.0,
                    "air_temp_min":32.0,
                    "last_stage":"n/a",
                    "new_stage":"TA"
                },...
            }
        }
    },
    "stage_descriptions":{
        "TA":{
            "description":"Turfgrass starts a transition phase from dormant to active.",
            "images":[],
            "name":"Beginning Transition to Active"
        },...
    }
}

Bermuda Turfgrass

Bermuda Turfgrass Growth Creation - v1.0

This endpoint allows users to create a bermuda turfgrass growth on an existing field. Users adding a bermuda turfgrass growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_date={string}&variety={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

start_date

string

yes

Start date of the model, formatted either as a date string (YYYY-MM-DD) or a Unix timestamp. (Note that this is stored only as a timestamp in the database.)

variety

string

yes

Subclass of bermuda turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&start_date=1525132800&variety=generic
Example Response
abc-def

Bermuda Turfgrass Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

start_date

Start date of the model in the form of a Unix timestamp.

variety

Subclass of bermuda turfgrass. Currently, only "generic" is supported.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_name":"bermuda turfgrass",
    "plant_type":78,
    "start_date":1525132800,
    "variety":"generic",
    "zone_map_id":null
}

Bermuda Turfgrass Growth Modify - v1.0

This endpoint allows a user to modify an existing bermuda turfgrass growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_date={string}&variety={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

start_date

string

no

Start date of the model, formatted either as a date string (YYYY-MM-DD) or a Unix timestamp. (Note that this is stored only as a timestamp in the database.)

variety

string

no

Subclass of bermuda turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Bermuda Turfgrass Growth Delete - v1.0

This endpoint allows users to delete a bermuda turfgrass growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Bermuda Turfgrass Growth - v1.0

The Bermuda Turfgrass Growth endpoint allows users to simulate the dormancy of bermuda turfgrass and determine when it is expected to be fully dormant, fully active, and in a transition phase between these two.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&start_date={string}&variety={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

start_date

string

yes

 — 

Start date of the model, formatted either as a date string (YYYY-MM-DD) or a Unix timestamp.

variety

string

yes

 — 

Subclass of bermuda turfgrass. Currently, only "generic" is supported.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Note that due to the perennial nature of turfgrass, the same stages can be reached multiple times in the simulation.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-05-01":{
                    "air_temp_max":66.0,
                    "air_temp_min":32.0,
                    "last_stage":"n/a",
                    "new_stage":"TA"
                },...
            }
        }
    },
    "stage_descriptions":{
        "TA":{
            "description":"Turfgrass starts a transition phase from dormant to active.",
            "images":[],
            "name":"Beginning Transition to Active"
        },...
    }
}

Canola

Canola Growth Creation - v1.0

This endpoint allows users to create a canola growth on an existing field. Users adding a canola growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly. Default is "medium".

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Canola Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"canola",
    "plant_type":59,
    "relative_maturity":"medium",
    "zone_map_id":null
}

Canola Growth Modify - v1.0

This endpoint allows a user to modify an existing canola growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Canola Growth Delete - v1.0

This endpoint allows users to delete a canola growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Canola Growth - v1.1

Leveraging Iteris' canola growth stage model, the Canola Growth endpoint allows users to model the maturation and development of canola crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/canola/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly. Default is "medium".

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/canola/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-23":{
                    "agdd":2128.5,
                    "air_temp_max":84.0,
                    "air_temp_min":72.0,
                    "gdd":37.0,
                    "last_stage":"ER",
                    "new_stage":"R"
                },...
            },
            "harvest_window":{
                "end":"2016-08-19",
                "start":"2016-07-30"
            }
        }
    },
    "stage_descriptions":{
        "R":{
            "advisor":"Harvest",
            "description":"About one third of the seeds on the main stem have changed color; the crop is ready to swath.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Mature",
                    "url":".../ripening4.png"
                },...
            ],
            "name":"Ripe",
            "order":"9"
        },...
    }
}

Canola Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/add/abc-123/1535760000/R?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Canola Growth Feedbacks by Growth - v1.1

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/canola/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/canola/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":59,
            "start_override":false,
            "stage":"R"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":59
    },...
]

Canola Growth Modify Feedback - v1.0

The Canola Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=R
Example Response
true

Canola Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Canola Growth with GDD Envelope - v1.1

The Canola Growth with GDD Envelope service provides canola growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/canola/growth/gdd_envelope?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly. Default is "medium".

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the minimum AGDD value was observed.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/canola/growth/gdd_envelope?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-23":{
                    "agdd":2128.5,
                    "agdd_envelope_max":2300.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2050.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":84.0,
                    "air_temp_min":72.0,
                    "gdd":37.0,
                    "last_stage":"ER",
                    "new_stage":"R"
                },...
            },
            "harvest_window":{
                "end":"2016-08-19",
                "start":"2016-07-30"
            }
        }
    },
    "stage_descriptions":{
        "R":{
            "advisor":"Harvest",
            "description":"About one third of the seeds on the main stem have changed color; the crop is ready to swath.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Mature",
                    "url":".../ripening4.png"
                },...
            ],
            "name":"Ripe",
            "order":"9"
        },...
    }
}

Corn

Corn Growth Creation - v1.0

This endpoint allows users to create a corn growth on an existing field. Users adding a corn growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={integer}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

integer

no

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity. Default is 100.

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Corn Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"corn",
    "plant_type":51,
    "relative_maturity":100,
    "zone_map_id":null
}

Corn Growth Modify - v1.0

This endpoint allows a user to modify an existing corn growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={integer}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

relative_maturity

integer

no

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Corn Growth Delete - v1.0

This endpoint allows users to delete a corn growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Corn Growth - v1.1

Leveraging Iteris' corn growth stage model, the Corn Growth endpoint allows users to model the maturation and development of corn crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/corn/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={integer}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

integer

no

 — 

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity. Default is 100.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/corn/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-09-15":{
                    "agdd":2459.0,
                    "air_temp_max":73.0,
                    "air_temp_min":58.0,
                    "gdd":15.5,
                    "last_stage":"r5",
                    "new_stage":"r6"
                },...
            },
            "harvest_window":{
                "end":"2016-10-29",
                "start":"2016-09-27"
            }
        }
    },
    "stage_descriptions":{
        "r6":{
            "advisor":"Harvest",
            "description":"A black layer forms at the base of the kernels blocking further dry matter accumulation. All starch in the kernels has hardened at this time.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R6 - Ear with silks and husk leaves (left) and without (right)",
                    "url":".../Figure_80_ISUE300.jpg"
                },...
            ],
            "name":"R6 - Physiological Maturity",
            "order":"11"
        },...
    }
}

Corn Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/add/abc-123/1535760000/r6?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Corn Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":51,
            "start_override":false,
            "stage":"r6"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":51
    },...
]

Corn Growth Modify Feedback - v1.0

The Corn Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=r6
Example Response
true

Corn Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Corn Growth with GDD Envelope - v1.1

The Corn Growth with GDD Envelope service provides corn growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/corn/growth/gdd_envelope?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={integer}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

integer

no

 — 

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity. Default is 100.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the minimum AGDD value was observed.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/corn/growth/gdd_envelope?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-09-15":{
                    "agdd":2459.0,
                    "agdd_envelope_max":2550.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2400.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":73.0,
                    "air_temp_min":58.0,
                    "gdd":15.5,
                    "last_stage":"r5",
                    "new_stage":"r6"
                },...
            },
            "harvest_window":{
                "end":"2016-10-29",
                "start":"2016-09-27"
            }
        }
    },
    "stage_descriptions":{
        "r6":{
            "advisor":"Harvest",
            "description":"A black layer forms at the base of the kernels blocking further dry matter accumulation. All starch in the kernels has hardened at this time.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R6 - Ear with silks and husk leaves (left) and without (right)",
                    "url":".../Figure_80_ISUE300.jpg"
                },...
            ],
            "name":"R6 - Physiological Maturity",
            "order":"11"
        },...
    }
}

Cotton

Cotton Growth Creation - v1.0

This endpoint allows users to create a cotton growth on an existing field. Users adding a cotton growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Cotton Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"cotton",
    "plant_type":65,
    "relative_maturity":"medium",
    "zone_map_id":null
}

Cotton Growth Modify - v1.0

This endpoint allows a user to modify an existing cotton growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Cotton Growth Delete - v1.0

This endpoint allows users to delete a cotton growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Cotton Growth - v1.1

Leveraging Iteris' cotton growth stage model, the Cotton Growth endpoint allows users to model the maturation and development of cotton crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/cotton/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/cotton/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-23":{
                    "agdd":1601.0,
                    "air_temp_max":89.0,
                    "air_temp_min":69.0,
                    "gdd":24.0,
                    "last_stage":"v2.0",
                    "new_stage":"v3.0"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            }
        }
    },
    "stage_descriptions":{
        "v3.0":{
            "advisor":"Pest/Disease",
            "description":"The first flowers are visible. A flower is pollinated on the first day it is open (white bloom stage) and turns pink or red the next day.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"White flower",
                    "url":".../Flower_bloom5.jpg"
                },...
            ],
            "name":"First Flowers",
            "order":"3"
        },...
    }
}

Cotton Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/add/abc-123/1535760000/v7.0?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Cotton Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":65,
            "start_override":false,
            "stage":"v7.0"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":65
    },...
]

Cotton Growth Modify Feedback - v1.0

The Cotton Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=v7.0
Example Response
true

Cotton Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Cotton Growth with GDD Envelope - v1.1

The Cotton Growth with GDD Envelope service provides cotton growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/cotton/growth/gdd_envelope?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the minimum AGDD value was observed.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/cotton/growth/gdd_envelope?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-23":{
                    "agdd":1601.0,
                    "agdd_envelope_max":1750.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":1350.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":89.0,
                    "air_temp_min":69.0,
                    "gdd":24.0,
                    "last_stage":"v2.0",
                    "new_stage":"v3.0"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            }
        }
    },
    "stage_descriptions":{
        "v3.0":{
            "advisor":"Pest/Disease",
            "description":"The first flowers are visible. A flower is pollinated on the first day it is open (white bloom stage) and turns pink or red the next day.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"White flower",
                    "url":".../Flower_bloom5.jpg"
                },...
            ],
            "name":"First Flowers",
            "order":"3"
        },...
    }
}

Peanut

Peanut Growth Creation - v1.0

This endpoint allows users to create a peanut growth on an existing field. Users adding a peanut growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&variety={string}&plant_depth={float}&name={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

variety

string

yes

Subclass of peanut. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties. Note that either variety name or ID may be provided, and will be represented only by its ID in the database.

plant_depth

float

no

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 10.0 cm. Default is 5.0.

name

string

no

Unique name to assign to the growth.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800&variety=0
Example Response
abc-def

Peanut Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_depth

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 10.0 cm.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

variety

Subclass of peanut. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "latitude":35.0,
    "longitude":-97.0,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_depth":5.0,
    "plant_name":"peanut",
    "plant_type":76,
    "variety":"0"
}

Peanut Growth Modify - v1.0

This endpoint allows a user to modify an existing peanut growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&variety={string}&plant_depth={float}&name={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

variety

string

no

Subclass of peanut. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties. Note that either variety name or ID may be provided, and will be represented only by its ID in the database.

plant_depth

float

no

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 10.0 cm.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Peanut Growth Delete - v1.0

This endpoint allows users to delete a peanut growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Peanut Growth - v1.0

Leveraging Iteris' peanut growth stage model, the Peanut Growth endpoint allows users to model the maturation and development of peanut crops.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&variety={string}&plant_depth={float}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

variety

string

yes

 — 

Subclass of peanut. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties. Note that either variety name or ID may be provided.

plant_depth

float

no

 — 

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 10.0 cm. Default is 5.0.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

gdd

Growing degree days accumulated on the current date.

last_reproductive_stage

The last known reproductive stage.

last_stage

The last known growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

last_vegetative_stage

The last known vegetative stage.

new_reproductive_stage

The crop may have entered a new reproductive stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous reproductive stage and the next reproductive stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

new_vegetative_stage

The crop may have entered a new vegetative stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous vegetative stage and the next vegetative stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-30":{
                    "agdd":1300.68,
                    "air_temp_max":81.0,
                    "air_temp_min":65.0,
                    "gdd":17.88,
                    "last_reproductive_stage":"R3",
                    "last_stage":"R3",
                    "last_vegetative_stage":"V14",
                    "new_reproductive_stage":"R5",
                    "new_stage":"R5",
                    "new_vegetative_stage":"V15"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            }
        }
    },
    "stage_descriptions":{
        "R5":{
            "advisor":"Pest/Disease",
            "description":"Plants have at least one fully-expanded pod with seeds beginning to grow.",
            "images":[],
            "name":"R5 - First Seed",
            "order":"20"
        },...
    }
}

Potato

Potato Growth Creation - v1.0

This endpoint allows users to create a potato growth on an existing field. Users adding a potato growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&variety={string}&name={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

variety

string

yes

Subclass of potato. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties. Note that either variety name or ID may be provided, and will be represented only by its ID in the database.

name

string

no

Unique name to assign to the growth.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800&variety=0
Example Response
abc-def

Potato Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

variety

Subclass of potato. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "latitude":35.0,
    "longitude":-97.0,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"potato",
    "plant_type":75,
    "variety":"0"
}

Potato Growth Modify - v1.0

This endpoint allows a user to modify an existing potato growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&variety={string}&name={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

variety

string

no

Subclass of potato. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties. Note that either variety name or ID may be provided, and will be represented only by its ID in the database.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Potato Growth Delete - v1.0

This endpoint allows users to delete a potato growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Potato Growth - v1.0

Leveraging Iteris' potato growth stage model, the Potato Growth endpoint allows users to model the maturation and development of potato crops.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&variety={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

variety

string

yes

 — 

Subclass of potato. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties. Note that either variety name or ID may be provided.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/potato/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-29":{
                    "agdd":1906.8,
                    "air_temp_max":83.0,
                    "air_temp_min":60.0,
                    "gdd":17.9,
                    "last_stage":"3",
                    "new_stage":"4"
                },...
            },
            "harvest_window":{
                "end":"2016-09-23",
                "start":"2016-08-29"
            }
        }
    },
    "stage_descriptions":{
        "4":{
            "advisor":"Harvest",
            "description":"Plants are completely dead; potatoes are harvest ready.",
            "images":[],
            "name":"Harvest",
            "order":"4"
        },...
    }
}

Sorghum

Sorghum Growth Creation - v1.0

This endpoint allows users to create a sorghum growth on an existing field. Users adding a sorghum growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Sorghum Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"sorghum",
    "plant_type":70,
    "relative_maturity":"medium",
    "zone_map_id":null
}

Sorghum Growth Modify - v1.0

This endpoint allows a user to modify an existing sorghum growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Sorghum Growth Delete - v1.0

This endpoint allows users to delete a sorghum growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Sorghum Growth - v1.0

Leveraging Iteris' sorghum growth stage model, the Sorghum Growth endpoint allows users to model the maturation and development of sorghum crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-10-15":{
                    "agdd":2757.5,
                    "air_temp_max":72.0,
                    "air_temp_min":44.0,
                    "gdd":11.0,
                    "last_stage":"11",
                    "new_stage":"12"
                },...
            },
            "harvest_window":{
                "end":"2016-11-17",
                "start":"2016-10-22"
            }
        }
    },
    "stage_descriptions":{
        "12":{
            "advisor":"Harvest",
            "description":"Grain achieves its maximum dry weight. Mature grain is identified by looking for the dark spot, the black layer, on the bottom of the kernel. Grain moisture ranges from 25 to 35%.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Physiological Maturity",
                    "url":".../Physiological+Maturity.png"
                },...
            ],
            "name":"Physiological Maturity",
            "order":"12"
        },...
    }
}

Sorghum Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/add/abc-123/1535760000/12?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Sorghum Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":70,
            "start_override":false,
            "stage":"12"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":70
    },...
]

Sorghum Growth Modify Feedback - v1.0

The Sorghum Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=12
Example Response
true

Sorghum Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Soybean

Soybean Growth Creation - v1.0

This endpoint allows users to create a soybean growth on an existing field. Users adding a soybean growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&maturity_group={string}&plant_depth={float}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

maturity_group

string

no

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Default is "3.0". Note that this is stored internally as relative_maturity.

plant_depth

float

no

The depth in centimeters that the crop was planted. Valid values range from 0.1 to 7.5 cm. Default is 3.5.

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Soybean Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_depth

The depth in centimeters that the crop was planted. Valid values range from 0.1 to 7.5 cm.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_depth":3.5,
    "plant_name":"soybean",
    "plant_type":66,
    "relative_maturity":"3.0",
    "zone_map_id":null
}

Soybean Growth Modify - v1.0

This endpoint allows a user to modify an existing soybean growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&maturity_group={string}&plant_depth={float}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

maturity_group

string

no

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Note that this is stored internally as relative_maturity.

plant_depth

float

no

The depth in centimeters that the crop was planted. Valid values range from 0.1 to 7.5 cm.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Soybean Growth Delete - v1.0

This endpoint allows users to delete a soybean growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Soybean Growth - v1.1

Leveraging Iteris' soybean growth stage model, the Soybean Growth endpoint allows users to model the maturation and development of soybean crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/soybean/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&maturity_group={string}&plant_depth={float}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

maturity_group

string

no

 — 

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Default is "3.0".

plant_depth

float

no

 — 

The depth in centimeters that the crop was planted. Valid values range from 0.1 to 7.5 cm. Default is 3.5.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_avg

Average daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_reproductive_stage

The last known reproductive stage.

last_stage

The last known growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

last_vegetative_stage

The last known vegetative stage.

new_reproductive_stage

The crop may have entered a new reproductive stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous reproductive stage and the next reproductive stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

new_vegetative_stage

The crop may have entered a new vegetative stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous vegetative stage and the next vegetative stage.

relative_humidity_avg

Average daily relative humidity. Obtained from historical, forecast, or climatological data, depending on the timeframe.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/soybean/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-20":{
                    "agdd":1656.57,
                    "air_temp_avg":61.0,
                    "air_temp_max":69.0,
                    "air_temp_min":53.0,
                    "gdd":11.31,
                    "last_reproductive_stage":"R7",
                    "last_stage":"R7",
                    "last_vegetative_stage":"V10",
                    "new_reproductive_stage":"R8",
                    "new_stage":"R8",
                    "new_vegetative_stage":"n/a",
                    "relative_humidity_avg":72.0
                },...
            },
            "harvest_window":{
                "end":"2016-09-14",
                "start":"2016-08-20"
            }
        }
    },
    "stage_descriptions":{
        "R8":{
            "advisor":"Harvest",
            "description":"Plants have at least 95 percent of pods that are brown.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R8 - Full maturity",
                    "url":".../R8.jpg"
                },...
            ],
            "name":"R8 - Harvest Maturity",
            "order":"21"
        },...
    }
}

Soybean Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/add/abc-123/1535760000/R8?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Soybean Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":66,
            "start_override":false,
            "stage":"R8"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":66
    },...
]

Soybean Growth Modify Feedback - v1.0

The Soybean Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=R8
Example Response
true

Soybean Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Soybean Growth with GDD Envelope - v1.1

The Soybean Growth with GDD Envelope service provides soybean growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/soybean/growth/gdd_envelope?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&maturity_group={string}&plant_depth={float}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

maturity_group

string

no

 — 

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Default is "3.0".

plant_depth

float

no

 — 

The depth in centimeters that the crop was planted. Valid values range from 0.1 to 7.5 cm. Default is 3.5.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the minimum AGDD value was observed.

air_temp_avg

Average daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_reproductive_stage

The last known reproductive stage.

last_stage

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

last_vegetative_stage

The last known vegetative stage.

new_reproductive_stage

The crop may have entered a new reproductive stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous reproductive stage and the next reproductive stage.

new_stage

The last known reproductive stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

new_vegetative_stage

The crop may have entered a new vegetative stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous vegetative stage and the next vegetative stage.

relative_humidity_avg

Average daily relative humidity. Obtained from historical, forecast, or climatological data, depending on the timeframe.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/soybean/growth/gdd_envelope?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-20":{
                    "agdd":1656.57,
                    "agdd_envelope_max":1750.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":1550.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_avg":61.0,
                    "air_temp_max":69.0,
                    "air_temp_min":53.0,
                    "gdd":11.31,
                    "last_reproductive_stage":"R7",
                    "last_stage":"R7",
                    "last_vegetative_stage":"V10",
                    "new_reproductive_stage":"R8",
                    "new_stage":"R8",
                    "new_vegetative_stage":"n/a",
                    "relative_humidity_avg":72.0
                },...
            },
            "harvest_window":{
                "end":"2016-09-14",
                "start":"2016-08-20"
            }
        }
    },
    "stage_descriptions":{
        "R8":{
            "advisor":"Harvest",
            "description":"Plants have at least 95 percent of pods that are brown.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R8 - Full maturity",
                    "url":".../R8.jpg"
                },...
            ],
            "name":"R8 - Harvest Maturity",
            "order":"21"
        },...
    }
}

Spring Wheat

Spring Wheat Growth Creation - v1.0

This endpoint allows users to create a spring wheat growth on an existing field. Users adding a spring wheat growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Spring Wheat Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"spring wheat",
    "plant_type":57,
    "relative_maturity":"medium",
    "zone_map_id":null
}

Spring Wheat Growth Modify - v1.0

This endpoint allows a user to modify an existing spring wheat growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Spring Wheat Growth Delete - v1.0

This endpoint allows users to delete a spring wheat growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Spring Wheat Growth - v1.1

Leveraging Iteris' spring wheat growth stage model, the Spring Wheat Growth endpoint allows users to model the maturation and development of spring wheat crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&scale={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

scale

string

no

no

Specifies which growth scale the response will display. Valid values include "feekes", "haun", and "zadoks". Default behavior is to utilize a unified scale and display the equivalent stages from all three scales in the response.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

applicable_scales/feekes

Stage equivalent in the Feekes scale.

applicable_scales/haun

Stage equivalent in the Haun scale.

applicable_scales/zadoks

Stage equivalent in the Zadoks scale.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-22":{
                    "agdd":2783.0,
                    "air_temp_max":91.0,
                    "air_temp_min":64.0,
                    "gdd":45.5,
                    "last_stage":"120",
                    "new_stage":"121"
                },...
            },
            "harvest_window":{
                "end":"2016-08-25",
                "start":"2016-08-03"
            }
        }
    },
    "stage_descriptions":{
        "121":{
            "advisor":"Harvest",
            "applicable_scales":{
                "feekes":"11.3",
                "haun":"15.6",
                "zadoks":"92"
            },
            "description":"Kernels are hard, but a fingernail can still make an imprint. Plants have lost all green color.",
            "images":[],
            "name":"Physiological Maturity",
            "order":"21"
        },...
    }
}

Spring Wheat Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/add/abc-123/1535760000/121?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Spring Wheat Growth Feedbacks by Growth - v1.1

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":57,
            "start_override":false,
            "stage":"121"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":57
    },...
]

Spring Wheat Growth Modify Feedback - v1.0

The Spring Wheat Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=121
Example Response
true

Spring Wheat Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Spring Wheat Growth with GDD Envelope - v1.1

The Spring Wheat Growth with GDD Envelope service provides spring wheat growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth/gdd_envelope?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&scale={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

scale

string

no

no

Specifies which growth scale the response will display. Valid values include "feekes", "haun", and "zadoks". Default behavior is to utilize a unified scale and display the equivalent stages from all three scales in the response.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the minimum AGDD value was observed.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

applicable_scales/feekes

Stage equivalent in the Feekes scale.

applicable_scales/haun

Stage equivalent in the Haun scale.

applicable_scales/zadoks

Stage equivalent in the Zadoks scale.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth/gdd_envelope?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-22":{
                    "agdd":2783.0,
                    "agdd_envelope_max":2850.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2550.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":91.0,
                    "air_temp_min":64.0,
                    "gdd":45.5,
                    "last_stage":"120",
                    "new_stage":"121"
                },...
            },
            "harvest_window":{
                "end":"2016-08-25",
                "start":"2016-08-03"
            }
        }
    },
    "stage_descriptions":{
        "121":{
            "advisor":"Harvest",
            "applicable_scales":{
                "feekes":"11.3",
                "haun":"15.6",
                "zadoks":"92"
            },
            "description":"Kernels are hard, but a fingernail can still make an imprint. Plants have lost all green color.",
            "images":[],
            "name":"Physiological Maturity",
            "order":"21"
        },...
    }
}

Sugar Beet

Sugar Beet Growth Creation - v1.0

This endpoint allows users to create a sugar beet growth on an existing field. Users adding a sugar beet growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&name={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

name

string

no

Unique name to assign to the growth.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Sugar Beet Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "latitude":35.0,
    "longitude":-97.0,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"sugar beet",
    "plant_type":60
}

Sugar Beet Growth Modify - v1.0

This endpoint allows a user to modify an existing sugar beet growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&name={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Sugar Beet Growth Delete - v1.0

This endpoint allows users to delete a sugar beet growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Sugar Beet Growth - v1.1

Leveraging Iteris' sugar beet growth stage model, the Sugar Beet Growth endpoint allows users to model the maturation and development of sugar beet crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/sugarbeet/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/sugarbeet/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-06-14":{
                    "agdd":1261.0,
                    "air_temp_max":70.0,
                    "air_temp_min":61.0,
                    "gdd":31.5,
                    "last_stage":"v9.0",
                    "new_stage":"v10.0"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            },
        }
    },
    "stage_descriptions":{
        "v10.0":{
            "advisor":"Pest/Disease",
            "description":"Ten true leaves have unfolded and there is no sign of the next leaf stage.",
            "images":[],
            "name":"10 Leaves",
            "order":"10"
        },...
    }
}

Sugar Beet Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/add/abc-123/1535760000/v10.0?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Sugar Beet Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":60,
            "start_override":false,
            "stage":"v10.0"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":60
    },...
]

Sugar Beet Growth Modify Feedback - v1.0

The Sugar Beet Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=v10.0
Example Response
true

Sugar Beet Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Sugar Beet Growth with GDD Envelope - v1.1

The Sugar Beet Growth with GDD Envelope service provides sugar beet growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/sugarbeet/growth/gdd_envelope?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the minimum AGDD value was observed.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/sugarbeet/growth/gdd_envelope?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-06-14":{
                    "agdd":1261.0,
                    "agdd_envelope_max":1450.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":1100.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":70.0,
                    "air_temp_min":61.0,
                    "gdd":31.5,
                    "last_stage":"v9.0",
                    "new_stage":"v10.0"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            }
        }
    },
    "stage_descriptions":{
        "v10.0":{
            "advisor":"Pest/Disease",
            "description":"Ten true leaves have unfolded and there is no sign of the next leaf stage.",
            "images":[],
            "name":"10 Leaves",
            "order":"10"
        },...
    }
}

Sunflower

Sunflower Growth Creation - v1.0

This endpoint allows users to create a sunflower growth on an existing field. Users adding a sunflower growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Sunflower Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_name":"sunflower",
    "plant_type":72,
    "relative_maturity":"medium",
    "zone_map_id":null
}

Sunflower Growth Modify - v1.0

This endpoint allows a user to modify an existing sunflower growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Sunflower Growth Delete - v1.0

This endpoint allows users to delete a sunflower growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Sunflower Growth - v1.0

Leveraging Iteris' sunflower growth stage model, the Sunflower Growth endpoint allows users to model the maturation and development of sunflower crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-30":{
                    "agdd":2886.0,
                    "air_temp_max":81.0,
                    "air_temp_min":50.0,
                    "gdd":21.5,
                    "last_stage":"30",
                    "new_stage":"31"
                },...
            },
            "harvest_window":{
                "end":"2016-10-08",
                "start":"2016-09-13"
            }
        }
    },
    "stage_descriptions":{
        "31":{
            "advisor":"Harvest",
            "description":"The back of the head is brown; the bracts turn yellow/brown.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R9 stage",
                    "url":".../R9.jpg"
                },...
            ],
            "name":"R9 - Physiological Maturity",
            "order":"17"
        },...
    }
}

Sunflower Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/add/abc-123/1535760000/31?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Sunflower Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":72,
            "start_override":false,
            "stage":"31"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":72
    },...
]

Sunflower Growth Modify Feedback - v1.0

The Sunflower Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=31
Example Response
true

Sunflower Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Winter Wheat

Winter Wheat Growth Creation - v1.0

This endpoint allows users to create a winter wheat growth on an existing field. Users adding a winter wheat growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&plant_depth={float}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

plant_date

timestamp

no*

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

plant_depth

float

no

The depth in centimeters that the crop was planted. Possible values range from 0.1 to 10.0 cm. Default is 5.0.

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1525132800
Example Response
abc-def

Winter Wheat Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

emergence_date

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_date

Date that the crop was planted in the form of a Unix timestamp.

plant_depth

The depth in centimeters that the crop was planted. Possible values range from 0.1 to 10.0 cm.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "emergence_date":null,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_date":1525132800,
    "plant_depth":5.0,
    "plant_name":"winter wheat",
    "plant_type":68,
    "relative_maturity":"medium",
    "zone_map_id":null
}

Winter Wheat Growth Modify - v1.0

This endpoint allows a user to modify an existing winter wheat growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&plant_depth={float}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

plant_date

timestamp

no

Date that the crop was planted in the form of a Unix timestamp.

emergence_date

timestamp

no

Date that the crop began to emerge from the soil, in the form of a Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly.

plant_depth

float

no

The depth in centimeters that the crop was planted. Possible values range from 0.1 to 10.0 cm.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Winter Wheat Growth Delete - v1.0

This endpoint allows users to delete a winter wheat growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Winter Wheat Growth - v1.1

Leveraging Iteris' winter wheat growth stage model, the Winter Wheat Growth endpoint allows users to model the maturation and development of winter wheat crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

Please note that winter wheat has a vernalization (cold) requirement that must be satisfied before floral initiation can occur. This requirement will not be met if winter temperatures do not get low enough, which means that the model will not go past the First Tiller stage.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/winter_wheat/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&plant_depth={float}&scale={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

plant_depth

float

no

 — 

The depth in centimeters that the crop was planted. Possible values range from 0.1 to 10.0 cm. Default is 5.0.

scale

string

no

no

Specifies which growth scale the response will display. Valid values include "feekes", "haun", and "zadoks". Default behavior is to utilize a unified scale and display the equivalent stages from all three scales in the response.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

applicable_scales/feekes

Stage equivalent in the Feekes scale.

applicable_scales/haun

Stage equivalent in the Haun scale.

applicable_scales/zadoks

Stage equivalent in the Zadoks scale.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/winter_wheat/growth?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2017-07-25":{
                    "agdd":2386.88,
                    "air_temp_max":81.0,
                    "air_temp_min":68.0,
                    "gdd":23.4,
                    "last_stage":"12",
                    "new_stage":"13"
                },...
            },
            "harvest_window":{
                "end":"2017-08-12",
                "start":"2017-07-25"
            }
        }
    },
    "stage_descriptions":{
        "13":{
            "advisor":"Harvest",
            "applicable_scales":{
                "feekes":"11.4",
                "haun":"n/a",
                "zadoks":"93"
            },
            "description":"The grain has dried after physiological maturity. The wheat crop is ready to be harvested.",
            "images":[],
            "name":"Harvest Ready",
            "order":"14"
        },...
    }
}

Winter Wheat Growth Add Feedback - v1.0

This endpoint allows users to provide observed growth stage timing to improve model results. Users providing feedback must have write privileges for the field in which the field growth belongs.

Additional information about providing growth model feedbacks is available in the Feedback Information section of the Appendix.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/add/{growth_id}/{timestamp}/{stage}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_override
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. The resulting feedback will be associated with this growth.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

flag

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/add/abc-123/1535760000/13?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
111-b2b

Winter Wheat Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target Growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Feedbacks associated with this growth will be returned.

Response Object (JSON)
Field Description

user_id

User ID provided by the Account API.

feedback/date

Date that the feedback is valid in the form of a Unix timestamp.

feedback/type

Enumeration value of plant.

feedback/start_override

True denotes feedback as meaning "the crop entered this stage on this date." False denotes feedback as meaning "the crop was observed in this stage on this date."

feedback/stage

Stage provided as feedback.

created

Feedback creation time in the form of a Unix timestamp.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/get/by_growth/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
[
    {
        "user_id":xyz-123,
        "feedback":{
            "date":1535760000,
            "type":68,
            "start_override":false,
            "stage":"13"
        },
        "created":1527811200,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"111-b2b",
        "type":68
    },...
]

Winter Wheat Growth Modify Feedback - v1.0

The Winter Wheat Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. Users providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/modify/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be modified.

timestamp

integer

yes

Valid date of the feedback in the form of a Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/modify/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123&timestamp=1535760000&stage=13
Example Response
true

Winter Wheat Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. Users deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/delete/{feedback_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID provided when adding a growth feedback. This feedback will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/delete/111-b2b?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Winter Wheat Growth with GDD Envelope - v1.1

The Winter Wheat Growth with GDD Envelope service provides winter wheat growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

Please note that winter wheat has a vernalization (cold) requirement that must be satisfied before floral initiation can occur. This requirement will not be met if winter temperatures do not get low enough, which means that the model will not go past the First Tiller stage.

URL Description
https://ag.us.clearapis.com/v1.1/crop_health/winter_wheat/growth/gdd_envelope?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&plant_depth={float}&scale={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium".

plant_depth

float

no

 — 

The depth in centimeters that the crop was planted. Possible values range from 0.1 to 10.0 cm. Default is 5.0.

scale

string

no

no

Specifies which growth scale the response will display. Valid values include "feekes", "haun", and "zadoks". Default behavior is to utilize a unified scale and display the equivalent stages from all three scales in the response.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from the beginning of the model run, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the minimum AGDD value was observed.

air_temp_max

Maximum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

air_temp_min

Minimum daily air temperature at 2 meters above ground level in degrees Fahrenheit.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

applicable_scales/feekes

Stage equivalent in the Feekes scale.

applicable_scales/haun

Stage equivalent in the Haun scale.

applicable_scales/zadoks

Stage equivalent in the Zadoks scale.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request
https://ag.us.clearapis.com/v1.1/crop_health/winter_wheat/growth/gdd_envelope?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&days=100
Example Response
{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2017-07-25":{
                    "agdd":2386.88,
                    "agdd_envelope_max":2550.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2250.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":81.0,
                    "air_temp_min":68.0,
                    "gdd":23.4,
                    "last_stage":"12",
                    "new_stage":"13"
                },...
            },
            "harvest_window":{
                "end":"2017-08-12",
                "start":"2017-07-25"
            }
        }
    },
    "stage_descriptions":{
        "13":{
            "advisor":"Harvest",
            "applicable_scales":{
                "feekes":"11.4",
                "haun":"n/a",
                "zadoks":"93"
            },
            "description":"The grain has dried after physiological maturity. The wheat crop is ready to be harvested.",
            "images":[],
            "name":"Harvest Ready",
            "order":"14"
        },...
    }
}

Zoysia Turfgrass

Zoysia Turfgrass Growth Creation - v1.0

This endpoint allows users to create a zoysia turfgrass growth on an existing field. Users adding a zoysia turfgrass growth must have write privileges for the field being updated.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/create/{field_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_date={string}&variety={string}&name={string}&max_moisture_ depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}&zone_map_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Field ID provided by the Account API. The resulting growth will be associated with this field.

start_date

string

yes

Start date of the model, formatted either as a date string (YYYY-MM-DD) or a Unix timestamp. (Note that this is stored only as a timestamp in the database.)

variety

string

yes

Subclass of zoysia turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point. The default value is 0%, indicating recommended irrigation activities will try not to exceed field capacity.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. By default, irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

zone_map_id

string

no

The target zone map ID must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/create/abc-123?app_id=456&app_key=789&account_id=123&user_id=xyz-123&start_date=1525132800&variety=generic
Example Response
abc-def

Zoysia Turfgrass Get Growth - v1.0

This endpoint allows a user to retrieve a previously created growth based on growth ID.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/get/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be returned.

Response Object (JSON)
Field Description

acres

Areal size of the field in acres.

created

Growth creation time in the form of a Unix timestamp.

field_id

Field ID provided by the Account API. This is the field to which the target growth has been assigned.

field_name

Name of the field

growth_id

Growth ID provided by the Growth Creation endpoint.

irrigation_rec_zone

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. A value of "null" indicates that irrigation recommendations will be triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

latitude

Latitude coordinate of the field in decimal degrees.

longitude

Longitude coordinate of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

name

Name of the growth.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

start_date

Start date of the model in the form of a Unix timestamp.

variety

Subclass of zoysia turfgrass. Currently, only "generic" is supported.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/get/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
{
    "acres":80.0,
    "created":1527811200,
    "field_id":"abc-123",
    "field_name":"MyField",
    "growth_id":"abc-def",
    "irrigation_rec_zone":null,
    "latitude":35.0,
    "longitude":-97.0,
    "max_moisture_depletion":null,
    "max_moisture_refill":null,
    "name":"MyGrowth",
    "plant_name":"zoysia turfgrass",
    "plant_type":79,
    "start_date":1525132800,
    "variety":"generic",
    "zone_map_id":null
}

Zoysia Turfgrass Growth Modify - v1.0

This endpoint allows a user to modify an existing zoysia turfgrass growth.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/modify/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}&start_date={string}&variety={string}&name={string}&max_moisture_depletion={float}&max_moisture_refill={float}&irrigation_rec_zone={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. Properties of this growth will be modified.

start_date

string

no

Start date of the model, formatted either as a date string (YYYY-MM-DD) or a Unix timestamp. (Note that this is stored only as a timestamp in the database.)

variety

string

no

Subclass of zoysia turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth.

max_moisture_depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur), with practical values typically ranging from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

irrigation_rec_zone

string

no

For growths with an associated zone map, which can be used with IMFocus products. This setting determines the behavior for generating irrigation recommendations. If a target management zone ID is provided (UUID), irrigation recommendations will be triggered when the root zone soil moisture in that zone dries to the maximum allowable depletion value, regardless of conditions in other management zones within the zone map. "Null" can be provided to reinstate the default behavior in which irrigation recommendations are triggered by whichever management zone first dries to the maximum allowable depletion value for root zone soil moisture.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/modify/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123&name=MyModifiedGrowth
Example Response
true

Zoysia Turfgrass Growth Delete - v1.0

This endpoint allows users to delete a zoysia turfgrass growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/delete/{growth_id}?app_id={string}&app_key={string}&account_id={string}&user_id={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Growth Creation endpoint. This growth will be removed.

Response Object

Returns "true" on success.

Example Request
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/delete/abc-def?app_id=456&app_key=789&account_id=123&user_id=xyz-123
Example Response
true

Zoysia Turfgrass Growth - v1.0

The Zoysia Turfgrass Growth endpoint allows users to simulate the dormancy of zoysia turfgrass and determine when it is expected to be fully dormant, fully active, and in a transition phase between these two.

URL Description
https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&start_date={string}&variety={string}&days={integer}
Request Parameters
Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id