Browse
Climatic water-stress assessment โ seasonal water deficit and the resulting stress band.
Returns the latest water assessment per facility, 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/facilities/water
โถ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[water_budget_level] | string (eq, in) | Stress band (low, moderate, high, severe). |
filter[since] | date (eq) | Only assessments with sco2_run_at on or after this date. |
โถSorting
?sort= keys (leading - = descending): since (default -since), water_budget_score, created_at.
โถResponse
- 200 โ Paginated list of water 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 Water-specific attributes:
| Field | Type | Description |
|---|---|---|
water_budget_score | number | null | Climatic water-stress index (0โ1). Higher means more stressed. |
water_budget_level | string | null | Stress band โ low, moderate, high or severe. |
water_budget_cwd_mm | number | null | Seasonal climatic water deficit, in mm/yr. |
โถReading the score
water_budget_score is climatic: it is derived from the seasonal water
deficit at the location, not from local abstraction, permitting or catchment
allocation. Read it as exposure to water stress rather than as a measure of how
much water an operation actually draws.
โถSample response
{
"meta": {
"page": 1,
"page_size": 1,
"total": 1,
"has_next": false
},
"links": {
"self": "/assessments/facilities/water"
},
"data": [
{
"type": "assessment",
"id": "3fad3b99-0000-0000-0000-000000000000",
"attributes": {
"location_id": "81895eee-e2bd-4b65-b75d-3c92110b5552",
"location_type": "facility",
"commodity": "palm",
"country_code": "BR",
"name": "Example Facility",
"water_budget_score": 0.64,
"water_budget_level": "high",
"water_budget_cwd_mm": 812.5
},
"links": {
"self": "/assessments/facilities/81895eee-e2bd-4b65-b75d-3c92110b5552/water"
}
}
]
}
Required scope:
assessments:read