Skip to main content
Version: 0.13.0

Temporal coverage tool

Introduced 0.13.0

The TemporalCoverageTool, which an agent sees as WhenWasThisImaged, reports when a place was imaged and where the gaps are. Use it to choose a baseline before FindChanges.

The answer includes how many acquisitions exist, the newest and oldest dates, and the longest gap — with the two dates that bound that gap.

time_field is required. An index usually carries several dates (capture, ingest, last write); the tool uses the one you name and repeats it in the answer.

The most recent 500 distinct acquisitions are examined for gaps. When the archive holds more, the true oldest date is still reported from a separate aggregation, and the answer states that the gap scan covered the most recent 500 acquisitions.

Parameters​

ParameterRequiredDescription
indexYesThe index holding the acquisitions.
time_fieldYesThe date field holding capture time.
queryNoA phrase that restricts which acquisitions count.
areaNoAn area of interest, as WKT.
fieldNoThe geometry field area is tested against.

Register a flow agent that runs the TemporalCoverageTool​

POST /_plugins/_agent/agents/_register
{
  "name": "Coverage_Agent",
  "type": "flow",
  "description": "reports when a place was imaged",
  "tools": [
    {
      "type": "TemporalCoverageTool",
      "name": "DemoWhenWasThisImaged",
      "parameters": {
        "index": "land_cover",
        "time_field": "captured_at"
      }
    }
  ]
}