Shed Deforestation
List shed-level deforestation metrics.
Shed metrics are mid-level aggregations of plot data within a supply shed area.
โถURL structure
GET /metrics/sheds/deforestation
GET /metrics/sheds/deforestation/history
GET /metrics/sheds/deforestation/{commodity}
GET /metrics/sheds/deforestation/{commodity}/history
โถShed-specific attributes
| Field | Type | Description |
|---|---|---|
noncompliance_area | number | Non-compliant area (ha) |
forest_area | number | Forest area (ha) |
agreement | object | Source agreement scores |
overlap | object | Overlap fractions |
annual_defor | object | Annual deforestation time series |
uncertainty_rrmse | number | Relative RMSE uncertainty |
stat_type | string / null | How the shed boundary was drawn: watershed, admin_area or supply_shed. Null when not yet recorded. Not filterable. |
โถCommon attributes (all metric types)
| Field | Type | Description |
|---|---|---|
location_id | uuid | Staged location ID |
process_id | string | Processing run ID |
commodity | string | Commodity type |
organization_id | uuid | Owning organization |
monitoring_start_date | ISO 8601 | Monitoring period start |
monitoring_end_date | ISO 8601 | Monitoring period end |
โถFilters
| Filter | Type | Description |
|---|---|---|
filter[location_id] | uuid | Filter by location ID (drills down: passing a facility ID returns descendants under that facility; passing a shed ID returns its plots) |
filter[process_id] | uuid or "latest" | Specific run or latest only |
filter[monitoring_end] | date | Date range (gte, lte) |
filter[organization_id] | uuid | Child org filter |
filter[tags] | tags | Filter by tags |
filter[deforestation_period] | enum (eudr, user) | Select the assessment period for dual-period rows. eudr = EUDR-cut-off assessment (use for compliance; is_compliant meaningful); user = since your own start_date. Deforestation-only. See Query Parameters. |
โถContent negotiation
JSON (default), GeoJSON, NDJSON, NDGeoJSON via Accept header.
โถGeometry (include_geometries)
include_geometries)Geometry is opt-in. By default the metric resource omits the geo
attribute (the location's geometry) โ the server doesn't read it from the
database, keeping responses small and fast. Pass ?include_geometries=true
to include it:
application/json/application/x-ndjsonโgeopresent only withinclude_geometries=true.application/geo+json/application/x-ndgeo+jsonโ geometry is always included; the flag isn't needed.
Accepted values are true / false (default false); any other value is 400. See Query Parameters โ Geometry.
Required scope:
metrics:read