Sign in
aoiMonitors

Get AOI Monitor

Returns the details of a single AOI monitor by its ID.

get/earthcache/aoi-monitors/{monitor_id}

Response

AOI monitor found.

idstring uuid required

Unique monitor identifier.

namestring required

Display name for the monitor.

descriptionstring nullable

Optional description.

run_mode'auto' | 'manual' required

"auto" runs the monitor on a recurring schedule; "manual" requires explicit triggering.

start_datestring date required

Start of the monitoring period (ISO 8601 date).

end_datestring date required

End of the monitoring period (ISO 8601 date).

last_run_timestring date-time nullable

Timestamp of the last monitor run.

max_cloud_covernumber nullable

Maximum acceptable cloud cover percentage (0–100).

min_aoi_coveragenumber nullable

Minimum required AOI coverage percentage (0–100).

notify_usersstring[] nullable

User IDs to notify when new imagery is found. MUA accounts only.

sourcesstring[] nullable

Satellite data sources to monitor.

min_resolutionnumber nullable

Minimum resolution filter in meters per pixel.

max_resolutionnumber nullable

Maximum resolution filter in meters per pixel.

off_nadir_anglenumber[] nullable

[min, max] off-nadir angle range in degrees. The first value must be less than the second.

project_idstring nullable

Associated project ID. MUA accounts only.

org_idstring nullable

Organization identifier.

user_idstring required

ID of the user who created the monitor.

sensor_typestring[] nullable

Sensor type filter.

originstring nullable

Origin identifier for the monitor.

created_atstring date-time nullable

Creation timestamp (ISO 8601).

updated_atstring date-time nullable

Last update timestamp (ISO 8601).

Example response

{
  "sources": [
    "sentinel-2",
    "landsat"
  ],
  "sensor_type": [
    "optical",
    "sar"
  ]
}

Changes