Facility Deforestation

Latest facility-level deforestation metrics (one per location).

Returns the most recent deforestation data per location, including fields unique to the facility level such as noncompliance_plot_count, plot_count, noncompliance_area_perc, and noncompliance_area_rate.

Append /history for all processing runs.

Assessment period

Facility aggregates are anchored to the EUDR assessment period, so each facility has a single deforestation row. filter[deforestation_period]=eq:eudr is therefore the effective default and eq:user returns no rows at this level โ€” the user-period split exists only on plot and shed metrics. See Query Parameters.

URL structure

GET /metrics/{location_type}/{metric}              โ€” latest per location
GET /metrics/{location_type}/{metric}/history       โ€” all processing runs
GET /metrics/{location_type}/{metric}/{commodity}   โ€” latest, filtered
GET /metrics/{location_type}/{metric}/{commodity}/history

Facility-specific attributes

FieldTypeDescription
noncompliance_areanumberNon-compliant area (ha)
forest_areanumberForest area (ha)
annual_deforobjectAnnual deforestation time series
uncertainty_rrmsenumberRelative RMSE uncertainty
noncompliance_plot_countnumberCount of non-compliant plots
noncompliance_area_percnumberNon-compliance area as fraction
noncompliance_area_ratenumberNon-compliance rate (fraction/year)
areanumberTotal facility area (ha)
plot_countnumberTotal plots in facility

Convenience paths

PathDescription
GET /metrics/facilities/deforestationLatest per location (default)
GET /metrics/facilities/deforestation/historyAll processing runs
GET /metrics/facilities/deforestation/palmLatest, filtered by commodity
GET /metrics/facilities/deforestation/palm/historyAll runs for commodity

Sorting

Facility deforestation is the only metric route that accepts ?sort= โ€” the compliance-ranking keys below (leading - = descending). It composes with page[cursor]=, and any other key (or ?sort= on shed/plot routes or other metric families) returns 400.

Sort keyUse
noncompliance_plot_countRank facilities by non-compliant plot count. ?sort=-noncompliance_plot_count โ†’ most-deforested facilities first (the headline use case).
plot_countRank facilities by total plot count.

Both are backed by composite indexes on plot_agg_for. Ordering is one row per facility (the latest metric per facility), tie-broken by location id, with NULL counts last on - (descending). Available on the latest route, /history, and the /:commodity variants. See Query Parameters โ†’ Client-controlled sort.

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