Monitoring API Quickstart
This API quickstart guide walks you through a standard workflow using the Monitoring API endpoints.
Prerequisites
MGP Account credentials
To access the Monitoring API, you need an MGP account. You will use the username and password for this account to get a token, described in the next section.
- Don't have an MGP account yet? Contact Maxar Sales.
- Forgot your password? Visit https://account.maxar.com and choose "forgot password."
Get an API Key
The Monitoring API requires authentication.
Grant MGP write access to your cloud storage location
If you are creating a monitor that auto-orders data and delivers it to cloud storage, MGP needs write access to your cloud storage location before you place an order so the output files can be delivered. Learn how to grant write access to your cloud storage location:
Base URLs
The base URL for the account service is account.maxar.com. The base URL for the Monitoring API is api.maxar.com
Auto-Ordering Monitor
Order template (optional)
An order template is an array of one or more order request body objects. If an order template is included as part of the request, the monitor will automatically place an order to a content-producing pipeline when there is a match with a new image acquisition. For more information on specific order request body objects, navigate to our Monitor by Content Type sidebar.
1. Finding specific source details
Each monitoring is created within a so-called "source". These sources are essentially databases that house our imagery. Currently, the only source has the namespace discovery and the source_name catalog.
In the response, take note of items within the criteria_fields object. this contains all of the available monitor settings for imagery ordered through this source.
2. Construct a monitor request body
Use the Intro to Monitoring guide to learn how to construct a monitor request body. Make sure to include the order_templates field if you want your monitor to auto-order imagery as it becomes available.
Use the items from the criteria_fields object in the previous step to inform your settings object.
3. Create a monitor
Once you have constructed your monitor request, you may submit it to create your monitor. You should receive a notification confirming the creation of your monitor.
4. Listing monitors
You can easily view all monitors you have access to by submitting a GET monitor request. This returns a list of all of your monitors' settings, as well as their unique IDs. Take note of their IDs if you wish to make edits to your monitors.
5. Listing monitor's events
Every time your monitor finds a match, makes an order, or satisfies one of your criteria, it creates an event. You can view a list of these events by submitting a request with the monitor ID found above.
6. Update an existing monitor
Your monitor's description, notification settings, auto-ordering template, enabled status, and metadata may be updated at any time. Use the monitor_id found in step 4 to submit this request.
If you only want to change toggle the Monitor between enabled and disabled, use the Toggle Monitor request instead.