Monitoring with Auto-Ordering

Note: This guide is an addendum to the General Monitoring Guide. You must use the calls and information in that guide to complete the requests described in this guide.

This guide describes the criteria, processes, and options for creating a monitoring request with auto-ordering. Follow the steps described in our Monitoring without Auto-Ordering, and add an additional object called order_templates. The settings object within the order_templates object determines your ordering settings, and is created using the regular ordering settings for whichever product you are ordering through.

Example Auto-Ordering Request

{
    "source": "discovery/catalog",
    "description": "monitor description",
    "aoi_geojson": {
        "type": "Polygon",
        "coordinates": [
            [
                [-36.96, -10.52],
                [-36.96, -7.97],
                [-34.79, -7.97],
                [-34.79, -10.52],
                [-36.96, -10.52]
            ]
        ]
    },
  "start_datetime": "2025-02-18T00:00:00+00:00",
  "end_datetime": "2025-06-18T00:00:00+00:00",
    "match_criteria": {
        "platform": {"in": ["worldview-03", "worldview-02"]},
        "eo:cloud_cover": {"lt": 75}
    },
    "monitor_notifications": [
        {"type": "email",
         "target": "myemail@email.com"}
    ],
    "erode_area": true,
    "order_when_complete": false,
    "order_templates": [
        {
            "pipeline": "imagery/view-ready-ortho",
            "template": {
                "settings":{
                    "customer_description": "imagery order description",
                    "inventory_ids": ["$.id"],
                    "aoi": "$._aoi_intersection"
                },
                "output_configs": [
                    {
                        "type":"download",
                        "format":"zip"
                    }
                ],
                "notifications": [
                    {"type":"email", 
                    "target":"myemail@email.com"}
                ]
            }
        }
    ]
}

Order Templates

order_templates is an array of objects specifying the content production parameters and delivery location. If this attribute is included as part of the request, each monitor match event will trigger the specified content-producing products. Each object in an order template consists of two attributes: pipeline- that specifies the desired MGP product for content production, and template - which specifies content production and delivery configurations for that product.

The template object

The template object is similar to the payload sent to Ordering requests, but uses placeholders that the Monitoring API can substitute event specifics to create an order payload that can be passed to the ordering API on your behalf. Please reference the settings specification in your chosen content product(s) by viewing the ordering by content guides.

Order template placeholders

Placeholders can be used to populate the order template with values not currently known, or to populate the order template with a value referenced elsewhere in the request. The placeholder $.id must be used for the template object settings --> inventory_ids attribute if being ordered through a core imagery pipeline. The placeholder $._aoi_intersection must be used for the template object settings --> aoi attribute if being ordered through a core imagery pipeline.

Order request body $._image_ids placeholder

The $._image_ids placeholder operates in a similar context to the $.id placeholder. If your parameter order_when_complete is true, you should use the $._image_ids placeholder instead of the $.id placeholder. The $._image_ids placeholder stores the specific image identifiers gathered from all match events used to erode the AOI.

Example for the core imagery pipelines (imagery/system-ready, imagery/view-ready, imagery/view-ready-ortho, imagery/map-ready):

"inventory_ids": [
    "$._image_ids"
],

Order request body AOI placeholders

Content pipelines also require an AOI to be included as part of their request body.

When specifying the order templates, you will likely want to reference either the same AOI that you submitted for the request, the geometry of the yet-to-be-collected imagery strip, or the intersection of both. You can do this by using one of the following AOI placeholders:

Placeholder	Reference
$._event_geojson	a yet-to-be collected full strip footprint
$._aoi_geojson	the request AOI
$._aoi_intersection	the intersection of the yet-to-be-collected full strip footprint and the request AOI