Browse
Validation-time deforestation screen โ the risk band, the per-plot presence flag, and the deforested area (promoted out of core).
Returns the latest deforestation-screen assessment per supply shed, paginated and
filterable. All four response formats (application/json,
application/geo+json, application/x-ndjson, application/x-ndgeo+json)
are available via the Accept header โ see Response Formats.
โถRequest
โถMethod & Path
GET /assessments/sheds/deforestation-screen
โถFilters
All read endpoints share the location-level and ingestion-trace filters
(filter[field]=condition:value โ see Query Parameters):
| Filter | Type | Description |
|---|---|---|
organization_id | uuid | Owning organization ID. |
location_id | uuid | Staged location ID. |
commodity | enum | Commodity type. |
country_code | iso-country | ISO 3166-1 alpha-2. |
name | string | Location name. |
tags | tags | Tags on linked entities. |
created_at | date | Per-org link creation timestamp. |
country / admin_region / city | string | Normalised location-parity fields. |
facility_id / shed_id / plot_id | string / uuid | Underlying entity IDs. |
assets.task_id | uuid | Ingestion task ID. |
assets.filename | string | Source filename from ingestion. |
assets.data.* | wildcard | User-uploaded source columns (e.g. filter[assets.data.CITY]=London). |
This slug additionally supports:
| Filter | Type | Description |
|---|---|---|
filter[risk] | string (eq, in) | Deforestation risk band (low | high). |
filter[since] | date (eq) | Only assessments with sco2_run_at on or after this date. |
โถSorting
?sort= keys (leading - = descending): since (default -since), deforestation_area_ha, created_at.
โถResponse
- 200 โ Paginated list of deforestation-screen assessments.
- 400 / 401 / 403 โ See Error Codes.
โถdata[] attributes
data[] attributesEvery assessment resource carries the shared identity / meta block (sourced
from the location + ingestion joins, not the assessment data):
| Field | Type | Description |
|---|---|---|
location_id | uuid | Type-specific location ID. |
location_type | facility | shed | plot | Underlying entity type. |
commodity | string | null | Commodity type. |
country_code | string | null | ISO 3166-1 alpha-2 country code. |
name | string | null | Normalised location name. |
geo | GeoJSON | null | Location geometry. |
sco2_run_at | ISO 8601 | null | Timestamp of the run that produced this assessment. |
asset_task_id | uuid | Ingestion task that linked this location. |
created_at | ISO 8601 | null | Creation timestamp. |
updated_at | ISO 8601 | null | Last update timestamp. |
Plus the Deforestation Screen-specific attributes:
| Field | Type | Description |
|---|---|---|
risk | string | null | Deforestation risk band (low | high) from the summary. |
deforestation_present | boolean | null | Per-plot deforestation presence flag. |
deforestation_area_ha | number | null | Deforested area in hectares. |
deforestation_check_failed | boolean | null | True if the upstream EE deforestation check errored. |
This is the validation-time screen produced during ingestion โ distinct from the full deforestation metric served under
/metrics/{location_type}/deforestation.
โถSample response
{
"meta": {
"page": 1,
"page_size": 1,
"total": 1,
"has_next": false
},
"links": {
"self": "/assessments/sheds/deforestation-screen"
},
"data": [
{
"type": "assessment",
"id": "3fad3b99-0000-0000-0000-000000000000",
"attributes": {
"location_id": "81895eee-e2bd-4b65-b75d-3c92110b5552",
"location_type": "shed",
"commodity": "palm",
"country_code": "BR",
"name": "Example Supply Shed",
"risk": "low",
"deforestation_present": false,
"deforestation_area_ha": 0.0
},
"links": {
"self": "/assessments/sheds/81895eee-e2bd-4b65-b75d-3c92110b5552/deforestation-screen"
}
}
]
}
Required scope:
assessments:read