Get Specific Monitor

GET 
/monitors/:monitor_id

Retrieves a monitor configuration.

Request

Path Parameters

monitor_id stringrequired

REQUIRED. The ID of your monitor.

Responses

200

OK

application/json

Schema

Schema

data object
source string
start_datetime string
ISO-8601-formatted datetime string indicating when the monitor should start listening for events; if not provided, the monitor will start immediately
end_datetime string
ISO-8601-formatted datetime string indicating when the monitor should stop listening for events; if not provided, the monitor will continue listening until canceled by the owner
description string
aoi_geojson object
Geojson Polygon object
erode_area boolean
order_templates object[]
Array [
pipeline string
template object
output_config objectrequired
Configures output delivery location
oneOf
Amazon S3
amazon_s3 objectrequired
bucket stringrequired
prefix stringrequired
role_arn string
Google Cloud Storage
google_cloud_storage objectrequired
bucket stringrequired
prefix stringrequired
service_credentials stringrequired
Azure Blob Storage
azure_blob_storage objectrequired
container stringrequired
prefix stringrequired
sas_url stringrequired
File Download
download objectrequired
format stringrequired
Possible values: [zip, tar]
notifications object[]
Sets order notifications
Array [
oneOf
HTTP Callback
config object
headers object
internal_auth_provider string
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [http]
Amazon SNS
config object
requires_message_deduplication_id booleanrequired
requires_message_group_id booleanrequired
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [sns]
Email
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [email]
]
settings object
Specifies pipeline specific settings
metadata object
Arbitrary user key-value metadata
]
match_criteria object
monitor_notifications object[]
id string
date_created string
date_modified string
creator_id string
creator_group_id string
state
enabled boolean
monitor_links object
self string
events string
request_timestamp string
response_timestamp string
request_duration number
links object
request string

Example (from schema)

{
  "data": {
    "source": "discovery/catalog",
    "start_datetime": "2023-02-16T18:22:25Z",
    "end_datetime": "2023-02-16T18:22:25Z",
    "description": "Description of the monitor",
    "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
          ]
        ]
      ]
    },
    "erode_area": false,
    "order_templates": [
      {
        "pipeline": "imagery/analysis-ready",
        "template": {
          "output_config": {
            "amazon_s3": {
              "bucket": "string",
              "prefix": "string",
              "role_arn": "string"
            }
          },
          "notifications": [
            {
              "config": {
                "headers": {},
                "internal_auth_provider": "string"
              },
              "level": "FINAL_ONLY",
              "target": "string",
              "type": "http"
            },
            {
              "config": {
                "requires_message_deduplication_id": true,
                "requires_message_group_id": true
              },
              "level": "FINAL_ONLY",
              "target": "string",
              "type": "sns"
            },
            {
              "level": "FINAL_ONLY",
              "target": "string",
              "type": "email"
            }
          ],
          "settings": {},
          "metadata": {}
        }
      }
    ],
    "match_criteria": {
      "platform": {
        "in": [
          "worldview-03",
          "worldview-02"
        ]
      },
      "eo:cloud_cover": {
        "lt": 75
      },
      "aoi:coverage_sqkm": {
        "gte": 1
      }
    },
    "monitor_notifications": [
      {
        "type": "email",
        "target": "username@myemail.com"
      }
    ],
    "id": "1234123412341234",
    "date_created": "2023-02-16T18:22:25Z",
    "date_modified": "2023-02-16T18:22:25Z",
    "creator_id": "12341234",
    "creator_group_id": "NO_GROUP",
    "state": {},
    "enabled": true,
    "monitor_links": {
      "self": "https://api.maxar.com/v1/monitors/612258447717453999",
      "events": "https://api.maxar.com/monitors/6122584477174534999/events"
    }
  },
  "request_timestamp": "2022-12-01T23:19:02Z",
  "response_timestamp": "2022-12-01T23:19:06Z",
  "request_duration": 4,
  "links": {
    "request": "https://api.maxar.com/monitoring/v1/monitors/123123123123123"
  }
}

Loading...