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

FieldTypeDescription
noncompliance_areanumberNon-compliant area (ha)
forest_areanumberForest area (ha)
agreementobjectSource agreement scores
overlapobjectOverlap fractions
annual_deforobjectAnnual deforestation time series
uncertainty_rrmsenumberRelative RMSE uncertainty
stat_typestring / nullHow the shed boundary was drawn: watershed, admin_area or supply_shed. Null when not yet recorded. Not filterable.

Common attributes (all metric types)

FieldTypeDescription
location_iduuidStaged location ID
process_idstringProcessing run ID
commoditystringCommodity type
organization_iduuidOwning organization
monitoring_start_dateISO 8601Monitoring period start
monitoring_end_dateISO 8601Monitoring period end

Filters

FilterTypeDescription
filter[location_id]uuidFilter 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]dateDate range (gte, lte)
filter[organization_id]uuidChild org filter
filter[tags]tagsFilter 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)

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 โ€” geo present only with include_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