Intro to Monitoring

Overview

The Monitoring API lets you set up Monitors with an Area of Interest (AOI) and a set of criteria you specify to look for newly acquired matching imagery or other events. When a Monitor finds a matching event, it can send a notification or automatically order and deliver imagery or other data.

The source for the events is the MGP Discovery catalog. When an image is added or modified, this generates an event in the Monitoring system. This means that a "new" image may have an older collection date. However, the Monitoring system does not go back in time to find older imagery or events.

Constructing a Monitor request

Monitor Request Path:

POST https://api.maxar.com/monitoring/v1/monitors

Order templates

When an order template is included in a monitor, the data will be ordered based on the instructions provided. Data can be ordered as one of the following content types:

Content	namespace	source_name	Description	Ordering Example
Analysis-Ready Data (ARD)	imagery	analysis-ready	Analysis-Ready COGs and accompanying metadata. Note: WorldView-Legion imagery cannot currently be ordered as ARD.	Order Analysis-Ready Data
System-Ready(1B) Imagery	imagery	system-ready	Processing level 1B. Sensor corrected, un-projected (raw) product.	Order System-Ready Imagery
View-Ready(2A) Imagery	imager	view-ready	Processing level 2A. Projected and resampled, coarse DEM applied.	Order View-Ready Imagery
View-Ready Orthorectified (OR2A) Imagery	imagery	view-ready-orthoj	Processing level OR2A. Projected and resampled, projected to average base elevation.	Order View-Ready Orthorectified Imagery
Map-Ready(3D) Imagery	imagery	map-ready	Processing level 3D. High-quality standardized orthorectified imagery.	Order Map-Ready Imagery
Object Detection (Inference)	insights	object-detection	Object detections from imagery, images can also be ordered for an additional charge.	Object Detection (Inference)

Ordering template details

order_templates is an array of one or more Ordering API request body objects. This attribute configures ordering and delivery to one or more content pipelines after the request has been fulfilled. When configuring the order templates, you will need to use placeholder values.

Monitor only Example

This example shows a JSON request body that does not include an ordering template. This monitor will send a notification only when it finds a match.

Monitor Request Path:

POST https://api.maxar.com/monitoring/v1/monitors

Monitor request example:

{
  "source": "discovery/catalog",
  "start_datetime": "2025-02-18T00:00:00+00:00",
  "end_datetime": "2025-06-18T00:00:00+00:00",
  "description": "monitor description",
    "aoi_geojson": {
        "type": "Polygon",
        "coordinates": [
            [
                [-106.8, 35.1],
                [-106.4, 35.1],
                [-106.4, 35.4],
                [-106.8, 35.4],
                [-106.8, 35.1]
            ]
        ]
    },
    "match_criteria": {
        "platform": {
            "in": ["worldview-03", "worldview-02"]
        },
        "eo:cloud_cover": {
            "lt": 75
        },
        "aoi:coverage_sqkm": {
            "gte": 1
        }
    },
    "erode_area": true,
    "monitor_notifications": [{
        "type": "email",
        "target": "myemail@email.com"
    }]
}

Monitor and Order Example

This example shows a JSON request body that includes an Ordering Template. This monitor will auto-order imagery when the monitor finds a match. To see content-specific examples, navigate to the Monitor by Content Type sidebar.

Monitor Request Path:

POST https://api.maxar.com/monitoring/v1/monitors

Example 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@myemail.com"
                    }
                ]
            }
        }
    ]
}