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):

FilterTypeDescription
organization_iduuidOwning organization ID.
location_iduuidStaged location ID.
commodityenumCommodity type.
country_codeiso-countryISO 3166-1 alpha-2.
namestringLocation name.
tagstagsTags on linked entities.
created_atdatePer-org link creation timestamp.
country / admin_region / citystringNormalised location-parity fields.
facility_id / shed_id / plot_idstring / uuidUnderlying entity IDs.
assets.task_iduuidIngestion task ID.
assets.filenamestringSource filename from ingestion.
assets.data.*wildcardUser-uploaded source columns (e.g. filter[assets.data.CITY]=London).

This slug additionally supports:

FilterTypeDescription
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

Every assessment resource carries the shared identity / meta block (sourced from the location + ingestion joins, not the assessment data):

FieldTypeDescription
location_iduuidType-specific location ID.
location_typefacility | shed | plotUnderlying entity type.
commoditystring | nullCommodity type.
country_codestring | nullISO 3166-1 alpha-2 country code.
namestring | nullNormalised location name.
geoGeoJSON | nullLocation geometry.
sco2_run_atISO 8601 | nullTimestamp of the run that produced this assessment.
asset_task_iduuidIngestion task that linked this location.
created_atISO 8601 | nullCreation timestamp.
updated_atISO 8601 | nullLast update timestamp.

Plus the Water-specific attributes:

FieldTypeDescription
water_budget_scorenumber | nullClimatic water-stress index (0โ€“1). Higher means more stressed.
water_budget_levelstring | nullStress band โ€” low, moderate, high or severe.
water_budget_cwd_mmnumber | nullSeasonal 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