Estimate Usage

POST 
/pipelines/:namespace/:name/estimate

Get a usage estimate for an order request before placing the order. As part of the process the order is also validated.

Request

Path Parameters

namespace stringrequired
REQUIRED. A group of pipelines.
Example: imagery
name stringrequired
REQUIRED. The name of the pipeline.
Example: view-ready-ortho

application/json

Body

output_configs object[]required
Sets delivery notifications
Array [
oneOf
Amazon S3
type stringrequired
Possible values: [amazon_s3]
bucket stringrequired
prefix stringrequired
role_arn string
Google Cloud Storage
type stringrequired
Possible values: [google_cloud_storage]
bucket stringrequired
prefix stringrequired
service_credentials stringrequired
Azure Blob Storage
type stringrequired
Possible values: [azure_blob_storage]
container stringrequired
prefix stringrequired
sas_url stringrequired
File Download
type stringrequired
Possible values: [download]
format stringrequired
Possible values: [zip, tar]
MGP Order Manager
type stringrequired
Possible values: [mgp_order_manager]
]
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

Responses

200

OK

application/json

Schema

Schema

data objectrequired
links objectrequired
request string
request_timestamp stringrequired
response_timestamp stringrequired
request_duration numberrequired

Example (from schema)

{
  "data": {},
  "links": {
    "request": "https://api.maxar.com/ordering/v1/pipelines/imagery/analysis-ready/order"
  },
  "request_timestamp": "2022-12-01T23:19:02Z",
  "response_timestamp": "2022-12-01T23:19:06Z",
  "request_duration": 4
}

Example

{
  "data": {
    "usage_estimate": [
      {
        "pipeline_id": "imagery/analysis-ready",
        "units": "sqkm",
        "quantity": 0,
        "product_id": 242,
        "date_reported": "2023-06-01T19:19:31Z",
        "description": "Fresh Archive Imagery < 90 Days",
        "billable": true
      },
      {
        "pipeline_id": "imagery/analysis-ready",
        "units": "sqkm",
        "quantity": 3,
        "product_id": 244,
        "date_reported": "2023-06-01T19:19:31Z",
        "description": "Standard Archive Imagery ≥ 90 Days",
        "billable": true
      }
    ],
    "order_config": {
      "pipeline_id": "imagery/analysis-ready",
      "settings": {
        "acquisitions": [
          "03cf5011-7fd0-49ab-8bcf-36d7e2a1075f-inv"
        ],
        "aoi": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                47.8,
                29.25
              ],
              [
                47.8,
                29.27
              ],
              [
                47.81,
                29.27
              ],
              [
                47.81,
                29.25
              ],
              [
                47.8,
                29.25
              ]
            ]
          ]
        },
        "ard_settings": {
          "bundle_adjust": true,
          "healthy_vegetation_mask": false,
          "water_mask": false
        }
      },
      "output_configs": [
        {
          "type": "amazon_s3",
          "bucket": "example-bucket",
          "prefix": "example-prefix"
        }
      ],
      "notifications": [
        {
          "type": "email",
          "target": "email@myemail.com",
          "level": "INTERMEDIATE"
        }
      ],
      "metadata": {
        "project_id": "onboarding"
      }
    }
  }
}

Loading...