Cropzones
Cropzone Object
Field | Value Example | Type | Description | How it Can Be Used |
---|---|---|---|---|
id | "99af33b6-87f9-45d9-8f1b-afefb85f9f9f" | String (UUID) | Unique identifier | Reference specific cropzone |
slug | "cool-wind-42" | String | Human readable name | For reference when humans are involved |
name | "cropzone 161542329" | String | Cropzone name | Display and identification |
area | 199 | Number | Size of cropzone | Area calculations and planning |
area_unit | "m2" | String | Unit of measurement | Area unit |
note | "note for cropzone" | String | Additional information | Free text field used to add comments |
labels | [] | Array | Tags/categories | Categorization and filtering |
timezone | "UTC" | String | Timezone of cropzone | Time-based calculations |
start_date | "2024-12-22T17:00:00Z" | String (ISO 8601) | Either planting date or creation date, prioritizing planting date if present | Timeline tracking |
end_date | null | String (ISO 8601)| null | Automatically set to harvesting date when harvest occurs, null otherwise | Duration tracking |
planting_date | "2024-12-22T17:00:00Z" | String (ISO 8601)| null | Date of planting | Crop lifecycle tracking |
dap | 30 | Number | null | Days after planting | Growth stage tracking |
generation | 0 | Number | Version/iteration number | Track crop's generation (e.g sugarcane) |
activities_count | 1 | Number | Number of activities | Activity tracking |
soil_samples_count | 0 | Number | Number of soil samples | Soil analysis tracking |
preview_uri | https://maps.googleapis.com/maps/api/sta.... | String | null | Preview image URL | Visual preview of the field on GMaps |
location | { centroid: {...}, boundary: {...} } | Object | Geographic information including centroid point and boundary polygon | Spatial analysis and mapping |
location.centroid | { type: "Point", coordinates: [99.63, 19.25, 458.88] } | Object | Center point of the cropzone with elevation | Location reference and elevation data |
location.boundary | { type: "Polygon", coordinates: [[...]] } | Object | Polygon defining the cropzone boundaries | Area definition and mapping |
predicted | { maturity_date: "...", harvest: "..." } | Object | Prediction data for crop outcomes | Crop planning and forecasting |
predicted.maturity_date | "2025-02-14T17:00:00Z" | String (ISO 8601)| null | Predicted date of crop maturity | Harvest planning |
predicted.maturity_date_computed_at | "2025-01-21T04:53:57Z" | String (ISO 8601)| null | Timestamp when maturity date prediction was computed | Track prediction freshness |
predicted.harvest | "7.956080125" | String | Predicted harvest amount | Yield forecasting |
predicted.harvest_unit | "tons" | String | Unit of measurement for predicted harvest | Standardize measurements |
predicted.harvest_computed_at | "2025-01-21T04:53:57Z" | String (ISO 8601)| null | Timestamp when harvest prediction was computed | Track prediction freshness |
predicted.yield | "0.0008258335193066223" | String | Predicted yield per area unit | Productivity forecasting |
predicted.yield_unit | "tons/m2" | String | Unit of measurement for predicted yield | Standardize measurements |
predicted.yield_computed_at | "2025-01-21T04:53:57Z" | String (ISO 8601)| null | Timestamp when yield prediction was computed | Track prediction freshness |
actual | { harvesting_date: "...", harvest: "..." } | Object | Actual harvest results | Performance analysis |
actual.harvesting_date | "2022-05-13T17:00:00Z" | String (ISO 8601) | Actual date of harvest | Historical record |
actual.harvest | "4.31" | String | Actual harvest amount | Yield analysis |
actual.harvest_unit | "tons" | String | Unit of measurement for actual harvest | Standardize measurements |
actual.yield | "0.0024078212290502793" | String | Actual yield per area unit | Productivity analysis |
actual.yield_unit | "tons/m2" | String | Unit of measurement for actual yield | Standardize measurements |
season | { id: "...", name: "...", start_datetime: "..." } | Object | Season information for the cropzone | Seasonal tracking and analysis |
season.id | "season-uuid" | String (UUID) | Unique identifier for the season | Season reference |
season.name | "Season 2024" | String | Name of the season | Season identification |
season.start_datetime | "2024-01-01T00:00:00Z" | String (ISO 8601) | Start date of the season | Season timeline tracking |
season.end_datetime | "2024-12-31T23:59:59Z" | String (ISO 8601) | End date of the season | Season duration tracking |
rs_stopped_at | "2023-08-29T08:05:10Z" | String (ISO 8601) | Datetime when remote sensing image fetching stopped | Remote sensing data tracking |
farm | { id: "...", name: "...", phone: "..." } | Object | Farm information associated with cropzone | Farm tracking and management |
farm.id | "0ee2865f-45bb-48f8-a56e-2161284ec358" | String (UUID) | Unique identifier of associated farm | Farm reference |
farm.name | "Osinski, Terry and Fadel" | String | Name of associated farm | Farm identification |
farm.phone | "+819012345678" | String | null | Contact phone number for the farm | Farm communication |
field | { id: "...", name: "..." } | Object | Field information associated with cropzone | Field tracking and management |
field.id | "d48e193f-b1b7-469a-a4fe-453e131cbb86" | String (UUID) | Unique identifier of associated field | Field reference |
field.name | "field 278614995" | String | Name of associated field | Field identification |
crop | Crop Object | Object | Crop information associated with cropzone | Crop tracking and management |
seed_usage | 3 | Number | null | Amount of seeds used | Seed usage tracking |
seed_usage_unit | "kg" | String | null | Unit of measurement for seed usage ("kg" or "bags") | Know the unit used for seeds usage |
The start_date
field uses the planting_date
when specified; if no planting date exists, it uses the cropzone's created_at
date.
The end_date
field remains null until a harvest occurs, at which point it's set to the harvesting_date
.
📄️ Create a new cropzone
Creates a cropzone under field
📄️ List of cropzones related to a field
Get a list of all cropzones associated with the field with `field_id` provided in url
📄️ Delete a cropzone
Delete cropzones. You must have an API token with the `organizations:write` scope.
📄️ Update cropzone information
Update Cropzone info. You must have an API token with the `organizations:write` scope.
📄️ Cropzone info
Get cropzone info
📄️ Archive a cropzone
Archive cropzones. You must have an API token with the `organizations:admin` or `organizations:write` scope.
📄️ Renew a cropzone for a new season
Renew a cropzone for a new season. Copies all attributes of current cropzone into a new one for the next season. You must have an API token with the `organizations:admin` or `organizations:write` scope.
📄️ Unarchive an archived cropzone
Unarchive an archived cropzone. You must have an API token with the `organizations:write` scope.
📄️ List of cropzones related to an organization
Get a list of all cropzones associated with the organization with `organization_id` provided in urlRequired `organizations:read` scope to access
📄️ List of cropzones related to an organization in geojson format
Get a list of all cropzones associated with the organization with `organization_id` provided in url.