Create a monitored area

Free to create. Fixes a bounding box and a quantity to measure; every new acquisition over it is measured automatically from then on. Each automatic check costs 2 tokens plus 0.5 per new scene measured, and a check that finds no new acquisition costs nothing. The area must be under 5,000 km² and the sensor is chosen from the metric. Requires the monitoring plan feature; area count is plan-gated and a 403 says which limit you hit.

post/api/v1/monitoring

Request

  • Base URL: https://offnadir-delta.com
  • URL: https://offnadir-delta.com/api/v1/monitoring
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

bboxnumber[] required

Area to measure, [minLon, minLat, maxLon, maxLat] (WGS84). Must be under 5,000 km².

metricstring required

What to count. Plain words work (ships, fires, vegetation, water, burn, snow, built_up, moisture, night_lights) as do index names (ship_detection, fire_count, ndvi, evi, savi, ndmi, ndwi, mndwi, ndbi, ndsi, nbr, dnb, vv, vh, rvi, rfdi, cr).

namestring

Label for the area.

satellitestring

The sensor to measure with, chosen the way the app’s monitoring form does it (satellite × metric) — e.g. ship detection on Sentinel-1 or on NISAR. Omit for the metric’s first sensor (ship detection: Sentinel-1).

start_datestring date

YYYY-MM-DD to begin the history from (default 3 months ago, as in the app). A longer backfill measures more scenes and costs more on the first check.

Response

The created area, and how it will be metered.

areaobject
meteringobject

Changes

No recorded changes to this operation across all 1 revision of this API.