Environment

The environment endpoints expose temperature analytics that combine AquaCloud sensor data with historical trends. All routes are read-only GET endpoints under the /v3/environment prefix and require the v3 authentication flow: send Authorization: Bearer <token> and, for non-premium farmer tiers, include the x-client-secret header issued for the integration. When filters yield no rows the API responds with 204 No Content.

Common query parameters

Name	Type	Default	Details
from_date	date	Today − 4 weeks	Flexible parsing (ISO 2024-02-29, 29/02/2024, mai 2024, week 8 2024, today, etc.). Partial inputs resolve to the start of the period.
to_date	date	Today	Same parsing rules; partial inputs resolve to the end of the period.
areas	list of strings	All areas	Comma-separated AquaCloud area names (Norwegian or English) or IDs. Use % to explicitly request all areas.
offset	integer ≥ 0	0	Number of rows to skip for pagination.
limit	integer (0–1000)	1000	Maximum number of rows returned. Internally the service fetches limit + 1 to set pagination.has_more.

Response envelope

All endpoints return a JSON object with:

• data: List of temperature records for the requested resource.
• pagination: Contains offset, limit, and has_more where pagination applies.
• metadata: Not populated by these routes but reserved by the shared response model.

Endpoints

GET /v3/environment/temperature-trends-by-region

Delivers multi-year temperature trends per production region.

Field	Type	Description
week	string (ISO date)	Monday of the measured ISO week.
weeknum / year	integer	ISO week number and calendar year.
area_id / area_name	integer / string	Source area identifier from AquaCloud.
aquacloud_area_name	string	Friendly name when available.
production_area_ids	array	Production area IDs contributing to the region.
temperature	number	Weekly average temperature.
trend, change	number	Short-term trend and change versus the previous week.
macro_trend, macro_change, macro_change_2	number	Longer-term trend metrics.
prev_year, prev_year_2	number	Same-week temperatures from one and two years prior.

Values are rounded to two decimal places by the API.

GET /v3/environment/temperature-depths-by-region

Breaks down temperatures by depth bands per production region.

Field	Type	Description
date	string (ISO date)	Observation date.
production_region_name	string	Production region label.
aquacloud_area_name, production_area_ids	string / array	Area context.
temperature_measurement_count	integer	Total measurements aggregated into the row.
temperature_shallow / temperature_medium / temperature_deep / temperature_unknown	number	Average temperatures at each depth band.
avg_temperature, min_temperature, max_temperature	number	Aggregated summary statistics.
sites_count	integer	Number of sites contributing measurements.

GET /v3/environment/temperature-by-week-and-region

Weekly average temperature statistics at the production-region level.

Field	Type	Description
production_region_name	string	Region label.
measurement_week_date	string	Monday of the ISO week.
avg_temperature / median_temperature	number	Benchmark temperature values.
min_site_avg_temperature / max_site_avg_temperature	number	Extremes among sites.
total_measurement_count	integer	Number of temperature measurements.
std_dev_avg_temperature	number	Standard deviation across site averages.
aquacloud_area_name, production_area_ids	string / array	Optional area metadata.

GET /v3/environment/temperature-by-production-area-and-week

More granular weekly statistics at the production-area level.

Field	Type	Description
production_area_id	integer	Production area identifier.
production_region_name	string	Region containing the area.
measurement_week_date	string	Monday of the ISO week.
avg_temperature, median_temperature	number	Benchmark temperatures.
min_site_avg_temperature, max_site_avg_temperature	number	Site extremes.
total_measurement_count	number	Measurement count aggregated (may be decimal).
std_dev_avg_temperature	number	Standard deviation of site averages.
is_current_week, is_previous_week	boolean	Flags highlighting the latest weeks.

GET /v3/environment/sea-temperature-analysis

Comprehensive sea-temperature dataset that blends weekly, monthly, and historical context.

Field	Type	Description
week_date / week_year / week_number	date / int	ISO week reference.
area_id, area_name, aquacloud_area_name	identifiers	Area metadata.
production_area_ids, production_region_name	array / string	Geographic context.
avg_temperature, median_temperature, min_temperature, max_temperature	number	Baseline statistics.
avg_temperature_shallow / avg_temperature_medium / avg_temperature_deep / avg_temperature_unknown	number	Depth-specific averages.
total_measurement_count, avg_sites_count, days_with_data	number / integer	Coverage indicators.
rolling_4week_avg, rolling_12week_trend, macro_trend	number	Rolling trend analytics.
week_over_week_change, temp_same_week_last_year, year_over_year_change, year_over_year_pct_change	number	Comparative deltas.
current_month_avg, current_month_period_type	number / string	Current-month aggregate.
month_avg_3year_historical, month_avg_5year_historical	number	Historical baselines.
current_month_vs_3year_diff, current_month_vs_5year_diff	number	Gap versus history.
monthly_status_vs_3year, monthly_status_vs_5year	string	Qualitative status labels.
is_current_week, is_previous_week, is_current_month	boolean	Temporal flags for highlighting.
month_name, season	string	Descriptive labels for reporting.

All numeric measurements are rounded to two decimal places by the API.

Example request

GET /v3/environment/temperature-depths-by-region?areas=Midt&from_date=2024-01-01&to_date=2024-03-31&limit=200 HTTP/1.1
Host: api.aquacloud.io
Authorization: Bearer <token>
x-client-secret: <client-secret>

Successful responses include the temperature rows in data, pagination info when more results are available, and share a consistent structure across all environment endpoints.