openapi: 3.0.3 info: title: Planet Tasking API version: 2.0.0 description: > High resolution satellite imagery as a service. For in-depth guides and usage examples, refer to the [Planet Tasking API Documentation](https://docs.planet.com/develop/apis/tasking/). paths: /tasking/v2/bulk/: get: operationId: tasking_v2_bulk_list description: >- Retrieve all bulk processes you have access to. This includes all bulk processes created within your organization. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: List Bulk Processes parameters: - in: query name: end_time schema: type: string format: date-time description: Filter by the end time to be equal to the given value - in: query name: end_time__gt schema: type: string format: date-time description: Filter by the end time to be greater than the given value - in: query name: end_time__gte schema: type: string format: date-time description: >- Filter by the end time to be greater than or equal to the given value - in: query name: end_time__lt schema: type: string format: date-time description: Filter by the end time to be less than the given value - in: query name: end_time__lte schema: type: string format: date-time description: Filter by the end time to be less than or equal to the given value - in: query name: failed_payload_count schema: type: integer description: Filter by the failed payload count to be equal to the given value - in: query name: failed_payload_count__gt schema: type: integer description: >- Filter by the failed payload count to be greater than the given value - in: query name: failed_payload_count__gte schema: type: integer description: >- Filter by the failed payload count to be greater than or equal to the given value - in: query name: failed_payload_count__lt schema: type: integer description: Filter by the failed payload count to be less than the given value - in: query name: failed_payload_count__lte schema: type: integer description: >- Filter by the failed payload count to be less than or equal to the given value - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - name: limit required: false in: query description: Number of results to return per page. schema: type: integer minimum: 1 maximum: 1000 - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer minimum: 0 maximum: 30000 - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. - in: query name: order_payloads__error__isnotnull schema: type: boolean description: Filter by the order payloads error to not be null/unset - in: query name: order_payloads__error__isnull schema: type: boolean description: Filter by the order payloads error to be null/unset - in: query name: order_payloads__order_id__isnotnull schema: type: boolean description: Filter by the order payloads order ID to not be null/unset - in: query name: order_payloads__order_id__isnull schema: type: boolean description: Filter by the order payloads order ID to be null/unset - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: payload_count schema: type: integer description: Filter by the payload count to be equal to the given value - in: query name: payload_count__gt schema: type: integer description: Filter by the payload count to be greater than the given value - in: query name: payload_count__gte schema: type: integer description: >- Filter by the payload count to be greater than or equal to the given value - in: query name: payload_count__lt schema: type: integer description: Filter by the payload count to be less than the given value - in: query name: payload_count__lte schema: type: integer description: >- Filter by the payload count to be less than or equal to the given value - in: query name: start_time schema: type: string format: date-time description: Filter by the start time to be equal to the given value - in: query name: start_time__gt schema: type: string format: date-time description: Filter by the start time to be greater than the given value - in: query name: start_time__gte schema: type: string format: date-time description: >- Filter by the start time to be greater than or equal to the given value - in: query name: start_time__lt schema: type: string format: date-time description: Filter by the start time to be less than the given value - in: query name: start_time__lte schema: type: string format: date-time description: Filter by the start time to be less than or equal to the given value - in: query name: status schema: type: string x-spec-enum-id: eede9d8905deb3d9 enum: - COMPLETE - PENDING - RUNNING description: |- Filter by the status to be equal to the given value * `PENDING` - Pending * `RUNNING` - Running * `COMPLETE` - Complete - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: status__ne schema: type: string description: Filter by the status to not be equal to the given value - in: query name: status__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form tags: - Bulk Processes security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBulkSummaryList' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' post: operationId: tasking_v2_bulk_create description: >- Submit an asynchronous request to bulk-process tasking orders. Orders may be created, edited or cancelled depending on the `operation_type`. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Create Bulk Order parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Bulk Processes requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkProcess' required: true security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/BulkProcess' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/bulk/{id}/: get: operationId: tasking_v2_bulk_retrieve description: >- After submitting a bulk order, this endpoint allows monitoring the status of that bulk request by its ID. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Bulk Order parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: path name: id schema: type: string format: uuid title: Bulk ID description: A UUID string identifying this bulk process. required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Bulk Processes security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkSummary' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/bulk/{id}/payloads/: get: operationId: tasking_v2_bulk_payloads_retrieve description: >- After submitting a bulk order, this endpoint provides an in-depth view of the tasking orders that were part of the bulk request, including the status of each tasking order. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Bulk Order Payloads parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: path name: id schema: type: string format: uuid title: Bulk ID description: A UUID string identifying this bulk process. required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Bulk Processes security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkSummary' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/captures/: get: operationId: tasking_v2_captures_list description: >- Retrieve all captures you have access to. This includes all captures related to your organization. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: List Captures parameters: - in: query name: acquired_time schema: type: string format: date-time description: Filter by the acquired time to be equal to the given value - in: query name: acquired_time__gt schema: type: string format: date-time description: Filter by the acquired time to be greater than the given value - in: query name: acquired_time__gte schema: type: string format: date-time description: >- Filter by the acquired time to be greater than or equal to the given value - in: query name: acquired_time__lt schema: type: string format: date-time description: Filter by the acquired time to be less than the given value - in: query name: acquired_time__lte schema: type: string format: date-time description: >- Filter by the acquired time to be less than or equal to the given value - in: query name: aqua_assessment schema: type: string x-spec-enum-id: 69697b3f82cb370b nullable: true enum: - ATTEMPT - INVALID - SUCCESS description: |- Filter by the aqua assessment to be equal to the given value * `SUCCESS` - Success * `ATTEMPT` - Attempt * `INVALID` - Invalid - in: query name: aqua_assessment__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: archive_time schema: type: string format: date-time description: Filter by the archive time to be equal to the given value - in: query name: archive_time__gt schema: type: string format: date-time description: Filter by the archive time to be greater than the given value - in: query name: archive_time__gte schema: type: string format: date-time description: >- Filter by the archive time to be greater than or equal to the given value - in: query name: archive_time__lt schema: type: string format: date-time description: Filter by the archive time to be less than the given value - in: query name: archive_time__lte schema: type: string format: date-time description: >- Filter by the archive time to be less than or equal to the given value - in: query name: assessment schema: type: string x-spec-enum-id: 69697b3f82cb370b nullable: true enum: - ATTEMPT - INVALID - SUCCESS description: |- Filter by the assessment to be equal to the given value * `SUCCESS` - Success * `ATTEMPT` - Attempt * `INVALID` - Invalid - in: query name: assessment__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: assessment__isnotnull schema: type: boolean description: Filter by the assessment to not be null/unset - in: query name: assessment__isnull schema: type: boolean description: Filter by the assessment to be null/unset - in: query name: assessment_time schema: type: string format: date-time description: Filter by the assessment time to be equal to the given value - in: query name: assessment_time__gt schema: type: string format: date-time description: Filter by the assessment time to be greater than the given value - in: query name: assessment_time__gte schema: type: string format: date-time description: >- Filter by the assessment time to be greater than or equal to the given value - in: query name: assessment_time__isnotnull schema: type: boolean description: Filter by the assessment time to not be null/unset - in: query name: assessment_time__isnull schema: type: boolean description: Filter by the assessment time to be null/unset - in: query name: assessment_time__lt schema: type: string format: date-time description: Filter by the assessment time to be less than the given value - in: query name: assessment_time__lte schema: type: string format: date-time description: >- Filter by the assessment time to be less than or equal to the given value - in: query name: assessment_user_email schema: type: string description: Filter by the assessment user email to be equal to the given value - in: query name: assessment_user_email__icontains schema: type: string description: >- Filter by the assessment user email to contain the given value (case-insensitive) - in: query name: assessment_user_email__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: assessment_user_email__isnotnull schema: type: boolean description: Filter by the assessment user email to not be null/unset - in: query name: assessment_user_email__isnull schema: type: boolean description: Filter by the assessment user email to be null/unset - in: query name: assessment_user_email__ne schema: type: string description: >- Filter by the assessment user email to not be equal to the given value - in: query name: assessment_user_email__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: cloud_cover__gt schema: type: number format: float description: Filter by the cloud cover to be greater than the given value - in: query name: cloud_cover__gte schema: type: number format: float description: >- Filter by the cloud cover to be greater than or equal to the given value - in: query name: cloud_cover__lt schema: type: number format: float description: Filter by the cloud cover to be less than the given value - in: query name: cloud_cover__lte schema: type: number format: float description: >- Filter by the cloud cover to be less than or equal to the given value - in: query name: cloud_cover_max__gt schema: type: number format: float description: >- Filter by the maximum cloud coverage to be greater than the given value - in: query name: cloud_cover_max__gte schema: type: number format: float description: >- Filter by the maximum cloud coverage to be greater than or equal to the given value - in: query name: cloud_cover_max__lt schema: type: number format: float description: Filter by the maximum cloud coverage to be less than the given value - in: query name: cloud_cover_max__lte schema: type: number format: float description: >- Filter by the maximum cloud coverage to be less than or equal to the given value - in: query name: combined_assessment schema: type: string x-spec-enum-id: 69697b3f82cb370b nullable: true enum: - ATTEMPT - INVALID - SUCCESS description: >- Filter by the combined assessment (deprecated, use Evaluation instead) to be equal to the given value * `SUCCESS` - Success * `ATTEMPT` - Attempt * `INVALID` - Invalid - in: query name: combined_assessment__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: combined_assessment__isnotnull schema: type: boolean description: >- Filter by the combined assessment (deprecated, use Evaluation instead) to not be null/unset - in: query name: combined_assessment__isnull schema: type: boolean description: >- Filter by the combined assessment (deprecated, use Evaluation instead) to be null/unset - in: query name: created_time schema: type: string format: date-time description: Filter by the created time to be equal to the given value - in: query name: created_time__gt schema: type: string format: date-time description: Filter by the created time to be greater than the given value - in: query name: created_time__gte schema: type: string format: date-time description: >- Filter by the created time to be greater than or equal to the given value - in: query name: created_time__lt schema: type: string format: date-time description: Filter by the created time to be less than the given value - in: query name: created_time__lte schema: type: string format: date-time description: >- Filter by the created time to be less than or equal to the given value - in: query name: customer_aoi_name schema: type: string description: Filter by the customer aoi name to be equal to the given value - in: query name: customer_aoi_name__icontains schema: type: string description: >- Filter by the customer aoi name to contain the given value (case-insensitive) - in: query name: customer_aoi_name__isnotnull schema: type: boolean description: Filter by the customer aoi name to not be null/unset - in: query name: customer_aoi_name__isnull schema: type: boolean description: Filter by the customer aoi name to be null/unset - in: query name: customer_aoi_name__ne schema: type: string description: Filter by the customer aoi name to not be equal to the given value - in: query name: customer_org_id schema: type: integer description: Filter by the customer org ID to be equal to the given value - in: query name: customer_org_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: customer_org_id__ne schema: type: integer description: Filter by the customer org ID to not be equal to the given value - in: query name: customer_org_id__notin schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: delivered_asset_types schema: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: >- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Filter by the delivered asset types to be equal to the given value - in: query name: delivered_asset_types__in schema: type: array items: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: >- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Multiple values may be separated by commas. explode: false style: form - in: query name: delivered_asset_types__ne schema: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: >- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: >- Filter by the delivered asset types to not be equal to the given value - in: query name: delivered_asset_types__notin schema: type: array items: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: >- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Multiple values may be separated by commas. explode: false style: form - in: query name: downloadable schema: type: boolean description: Filter by the downloadable to be equal to the given value - in: query name: evaluation schema: type: string x-spec-enum-id: 5bd1a88f0e6c6778 enum: - INVALID - NONE - SUCCESS description: |- Filter by the evaluation to be equal to the given value * `NONE` - None * `SUCCESS` - Success * `INVALID` - Invalid - in: query name: expired_time schema: type: string format: date-time description: Filter by the expired time to be equal to the given value - in: query name: expired_time__gt schema: type: string format: date-time description: Filter by the expired time to be greater than the given value - in: query name: expired_time__gte schema: type: string format: date-time description: >- Filter by the expired time to be greater than or equal to the given value - in: query name: expired_time__lt schema: type: string format: date-time description: Filter by the expired time to be less than the given value - in: query name: expired_time__lte schema: type: string format: date-time description: >- Filter by the expired time to be less than or equal to the given value - in: query name: fast_rectification_latency schema: type: string format: duration description: >- Filter by the fast rectification latency to be equal to the given value - in: query name: fast_rectification_latency__gt schema: type: string format: duration description: >- Filter by the fast rectification latency to be greater than the given value - in: query name: fast_rectification_latency__gte schema: type: string format: duration description: >- Filter by the fast rectification latency to be greater than or equal to the given value - in: query name: fast_rectification_latency__lt schema: type: string format: duration description: >- Filter by the fast rectification latency to be less than the given value - in: query name: fast_rectification_latency__lte schema: type: string format: duration description: >- Filter by the fast rectification latency to be less than or equal to the given value - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: format schema: type: string enum: - csv - json - in: query name: fulfilling schema: type: boolean description: Filter by the fulfilling to be equal to the given value - in: query name: full_ortho_latency schema: type: string format: duration description: >- Filter by the full orthorectification latency to be equal to the given value - in: query name: full_ortho_latency__gt schema: type: string format: duration description: >- Filter by the full orthorectification latency to be greater than the given value - in: query name: full_ortho_latency__gte schema: type: string format: duration description: >- Filter by the full orthorectification latency to be greater than or equal to the given value - in: query name: full_ortho_latency__lt schema: type: string format: duration description: >- Filter by the full orthorectification latency to be less than the given value - in: query name: full_ortho_latency__lte schema: type: string format: duration description: >- Filter by the full orthorectification latency to be less than or equal to the given value - in: query name: ground_id schema: type: string format: uuid description: Filter by the ground ID to be equal to the given value - in: query name: ground_id__in schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: ground_id__ne schema: type: string format: uuid description: Filter by the ground ID to not be equal to the given value - in: query name: ground_id__notin schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: id schema: type: string format: uuid description: Filter by the id to be equal to the given value - in: query name: id__in schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__ne schema: type: string format: uuid description: Filter by the id to not be equal to the given value - in: query name: id__notin schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: imaging_conops schema: type: string x-spec-enum-id: de24a0cacb2de93e enum: - dark - experimental - flatfield - glint - high_capacity - high_data_volume - nominal - video description: >- Filter by the imaging collection preset to be equal to the given value * `nominal` - Nominal * `high_capacity` - High Capacity * `high_data_volume` - High Data Volume * `experimental` - Experimental * `dark` - Dark * `glint` - Glint * `flatfield` - Flatfield * `video` - Video - in: query name: imaging_conops__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: imaging_conops__ne schema: type: string description: >- Filter by the imaging collection preset to not be equal to the given value - in: query name: imaging_conops__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: item_ids schema: type: string description: Filter by the item IDs to contain the given value - in: query name: l1a_latency schema: type: string format: duration description: Filter by the l1A latency to be equal to the given value - in: query name: l1a_latency__gt schema: type: string format: duration description: Filter by the l1A latency to be greater than the given value - in: query name: l1a_latency__gte schema: type: string format: duration description: >- Filter by the l1A latency to be greater than or equal to the given value - in: query name: l1a_latency__lt schema: type: string format: duration description: Filter by the l1A latency to be less than the given value - in: query name: l1a_latency__lte schema: type: string format: duration description: >- Filter by the l1A latency to be less than or equal to the given value - name: limit required: false in: query description: Number of results to return per page. schema: type: integer minimum: 1 maximum: 1000 - in: query name: metis_activity_id schema: type: string format: uuid description: Filter by the metis activity ID to be equal to the given value - in: query name: metis_activity_id__in schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: needs_manual_assessment schema: type: boolean description: Filter by the needs manual assessment to be equal to the given value - in: query name: off_nadir_angle_max schema: type: number format: float description: Filter by the maximum off-nadir angle to be equal to the given value - in: query name: off_nadir_angle_max__gt schema: type: number format: float description: >- Filter by the maximum off-nadir angle to be greater than the given value - in: query name: off_nadir_angle_max__gte schema: type: number format: float description: >- Filter by the maximum off-nadir angle to be greater than or equal to the given value - in: query name: off_nadir_angle_max__lt schema: type: number format: float description: >- Filter by the maximum off-nadir angle to be less than the given value - in: query name: off_nadir_angle_max__lte schema: type: number format: float description: >- Filter by the maximum off-nadir angle to be less than or equal to the given value - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer minimum: 0 maximum: 30000 - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. - in: query name: order__created_time schema: type: string format: date-time description: Filter by the order created time to be equal to the given value - in: query name: order__created_time__gt schema: type: string format: date-time description: Filter by the order created time to be greater than the given value - in: query name: order__created_time__gte schema: type: string format: date-time description: >- Filter by the order created time to be greater than or equal to the given value - in: query name: order__created_time__lt schema: type: string format: date-time description: Filter by the order created time to be less than the given value - in: query name: order__created_time__lte schema: type: string format: date-time description: >- Filter by the order created time to be less than or equal to the given value - in: query name: order__end_time schema: type: string format: date-time description: Filter by the order end time to be equal to the given value - in: query name: order__end_time__gt schema: type: string format: date-time description: Filter by the order end time to be greater than the given value - in: query name: order__end_time__gte schema: type: string format: date-time description: >- Filter by the order end time to be greater than or equal to the given value - in: query name: order__end_time__lt schema: type: string format: date-time description: Filter by the order end time to be less than the given value - in: query name: order__end_time__lte schema: type: string format: date-time description: >- Filter by the order end time to be less than or equal to the given value - in: query name: order__order_type schema: type: string x-spec-enum-id: 18df9b1d5988c26a enum: - IMAGE - STEREO - VIDEO description: |- Filter by the order order type to be equal to the given value * `IMAGE` - Image * `VIDEO` - Video * `STEREO` - Stereo - in: query name: order__order_type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: order__order_type__ne schema: type: string description: Filter by the order order type to not be equal to the given value - in: query name: order__order_type__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: order__priority schema: type: integer description: Filter by the order priority to be equal to the given value - in: query name: order__priority__gt schema: type: integer description: Filter by the order priority to be greater than the given value - in: query name: order__priority__gte schema: type: integer description: >- Filter by the order priority to be greater than or equal to the given value - in: query name: order__priority__lt schema: type: integer description: Filter by the order priority to be less than the given value - in: query name: order__priority__lte schema: type: integer description: >- Filter by the order priority to be less than or equal to the given value - in: query name: order__rank schema: type: integer description: Filter by the order rank to be equal to the given value - in: query name: order__rank__gt schema: type: integer description: Filter by the order rank to be greater than the given value - in: query name: order__rank__gte schema: type: integer description: >- Filter by the order rank to be greater than or equal to the given value - in: query name: order__rank__lt schema: type: integer description: Filter by the order rank to be less than the given value - in: query name: order__rank__lte schema: type: integer description: >- Filter by the order rank to be less than or equal to the given value - in: query name: order__start_time schema: type: string format: date-time description: Filter by the order start time to be equal to the given value - in: query name: order__start_time__gt schema: type: string format: date-time description: Filter by the order start time to be greater than the given value - in: query name: order__start_time__gte schema: type: string format: date-time description: >- Filter by the order start time to be greater than or equal to the given value - in: query name: order__start_time__lt schema: type: string format: date-time description: Filter by the order start time to be less than the given value - in: query name: order__start_time__lte schema: type: string format: date-time description: >- Filter by the order start time to be less than or equal to the given value - in: query name: order__status schema: type: string x-spec-enum-id: ce5b6ce9e674887f enum: - CANCELLED - EXPIRED - FAILED - FINALIZING - FULFILLED - IN_PROGRESS - PENDING - PENDING_CANCELLATION - RECEIVED - REJECTED - REQUESTED - WAITLISTED - WAITLIST_ABANDONED - WAITLIST_EXPIRED description: |- Filter by the order status to be equal to the given value * `RECEIVED` - Received * `PENDING` - Pending * `IN_PROGRESS` - In Progress * `EXPIRED` - Expired * `FULFILLED` - Fulfilled * `FAILED` - Failed * `CANCELLED` - Cancelled * `REQUESTED` - Requested * `FINALIZING` - Finalizing * `PENDING_CANCELLATION` - Pending Cancellation * `REJECTED` - Rejected * `WAITLISTED` - Waitlisted * `WAITLIST_ABANDONED` - Waitlist Abandoned * `WAITLIST_EXPIRED` - Waitlist Expired - in: query name: order__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: order__status__ne schema: type: string description: Filter by the order status to not be equal to the given value - in: query name: order__status__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: order_id schema: type: string format: uuid description: Filter by the order ID to be equal to the given value - in: query name: order_id__in schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: order_name schema: type: string description: Filter by the order name to be equal to the given value - in: query name: order_name__icontains schema: type: string description: >- Filter by the order name to contain the given value (case-insensitive) - in: query name: order_name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: order_name__ne schema: type: string description: Filter by the order name to not be equal to the given value - in: query name: order_name__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: pl_number schema: type: string description: Filter by the contract number to be equal to the given value - in: query name: pl_number__icontains schema: type: string description: >- Filter by the contract number to contain the given value (case-insensitive) - in: query name: pl_number__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: pl_number__ne schema: type: string description: Filter by the contract number to not be equal to the given value - in: query name: pl_number__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: planned_acquisition_time schema: type: string format: date-time description: >- Filter by the planned acquisition time to be equal to the given value - in: query name: planned_acquisition_time__gt schema: type: string format: date-time description: >- Filter by the planned acquisition time to be greater than the given value - in: query name: planned_acquisition_time__gte schema: type: string format: date-time description: >- Filter by the planned acquisition time to be greater than or equal to the given value - in: query name: planned_acquisition_time__lt schema: type: string format: date-time description: >- Filter by the planned acquisition time to be less than the given value - in: query name: planned_acquisition_time__lte schema: type: string format: date-time description: >- Filter by the planned acquisition time to be less than or equal to the given value - in: query name: prioritized_processing schema: type: boolean description: Filter by the prioritized processing to be equal to the given value - in: query name: product schema: type: string description: Filter by the product name to be equal to the given value - in: query name: product__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: product__ne schema: type: string description: Filter by the product name to not be equal to the given value - in: query name: product__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: published_time schema: type: string format: date-time description: Filter by the published to customer to be equal to the given value - in: query name: published_time__gt schema: type: string format: date-time description: >- Filter by the published to customer to be greater than the given value - in: query name: published_time__gte schema: type: string format: date-time description: >- Filter by the published to customer to be greater than or equal to the given value - in: query name: published_time__lt schema: type: string format: date-time description: Filter by the published to customer to be less than the given value - in: query name: published_time__lte schema: type: string format: date-time description: >- Filter by the published to customer to be less than or equal to the given value - in: query name: review_outcome schema: type: string x-spec-enum-id: 4ad54c4f079f113a nullable: true enum: - ACCEPTED - DECLINED - QUOTA_ADJUSTED - REFUNDED - REPROCESSED - RE_TASKED description: |- Filter by the capture review outcome to be equal to the given value * `DECLINED` - Declined * `REFUNDED` - Refunded * `RE_TASKED` - Re-tasked * `QUOTA_ADJUSTED` - Quota Adjusted * `REPROCESSED` - Reprocessed * `ACCEPTED` - Accepted - in: query name: review_outcome__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: review_outcome__isnull schema: type: boolean description: Filter by the capture review outcome to be null/unset - in: query name: review_status schema: type: string x-spec-enum-id: 32487bc51a00e681 enum: - IN_PROGRESS - PENDING - PROCESSED description: |- Filter by the capture review status to be equal to the given value * `PENDING` - Pending * `IN_PROGRESS` - In Progress * `PROCESSED` - Processed - in: query name: review_status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: review_status__isnull schema: type: boolean description: Filter by the capture review status to be null/unset - in: query name: satellite_hw_id schema: type: string description: Filter by the satellite hw ID to be equal to the given value - in: query name: satellite_hw_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: satellite_hw_id__ne schema: type: string description: Filter by the satellite hw ID to not be equal to the given value - in: query name: satellite_hw_id__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: satellite_type schema: type: string x-spec-enum-id: a084571859659279 enum: - PELICAN - SKYSAT - TANAGER description: |- Filter by the satellite type to be equal to the given value * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager - in: query name: satellite_type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: satellite_type__ne schema: type: string description: Filter by the satellite type to not be equal to the given value - in: query name: satellite_type__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: saturated_pixel_ratio schema: type: number format: float description: Filter by the saturated pixel ratio to be equal to the given value - in: query name: saturated_pixel_ratio__gt schema: type: number format: float description: >- Filter by the saturated pixel ratio to be greater than the given value - in: query name: saturated_pixel_ratio__gte schema: type: number format: float description: >- Filter by the saturated pixel ratio to be greater than or equal to the given value - in: query name: saturated_pixel_ratio__lt schema: type: number format: float description: Filter by the saturated pixel ratio to be less than the given value - in: query name: saturated_pixel_ratio__lte schema: type: number format: float description: >- Filter by the saturated pixel ratio to be less than or equal to the given value - in: query name: sensitivity_mode schema: type: string x-spec-enum-id: 164c294ecc3dfe16 enum: - GLINT - HIGH - MAX - MEDIUM - NOT_APPLICABLE - PUSHBROOM - STANDARD description: |- Filter by the sensitivity mode to be equal to the given value * `NOT_APPLICABLE` - Not Applicable * `GLINT` - Glint * `STANDARD` - Standard * `MEDIUM` - Medium * `HIGH` - High * `MAX` - Max * `PUSHBROOM` - Pushbroom - in: query name: sensitivity_mode__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: sensitivity_mode__ne schema: type: string description: Filter by the sensitivity mode to not be equal to the given value - in: query name: sensitivity_mode__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: status schema: type: string x-spec-enum-id: e2d271cbd0336dfc enum: - DERIVING - FAILED - PROCESSING - PUBLISHED - QUEUED - REMOVED - SCHEDULED description: |- Filter by the status to be equal to the given value * `SCHEDULED` - Scheduled * `REMOVED` - Removed * `QUEUED` - Queued * `PROCESSING` - Processing * `FAILED` - Failed * `DERIVING` - Deriving * `PUBLISHED` - Published - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: status__ne schema: type: string description: Filter by the status to not be equal to the given value - in: query name: status__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: strip_id schema: type: string description: Filter by the strip ID to be equal to the given value - in: query name: strip_id__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: strip_id__ne schema: type: string description: Filter by the strip ID to not be equal to the given value - in: query name: strip_id__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: strip_id_base schema: type: string description: Filter by the strip ID base to be equal to the given value - in: query name: strip_id_base__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: strip_id_base__ne schema: type: string description: Filter by the strip ID base to not be equal to the given value - in: query name: strip_id_base__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: task__created_time schema: type: string format: date-time description: Filter by the task created time to be equal to the given value - in: query name: task__created_time__gt schema: type: string format: date-time description: Filter by the task created time to be greater than the given value - in: query name: task__created_time__gte schema: type: string format: date-time description: >- Filter by the task created time to be greater than or equal to the given value - in: query name: task__created_time__lt schema: type: string format: date-time description: Filter by the task created time to be less than the given value - in: query name: task__created_time__lte schema: type: string format: date-time description: >- Filter by the task created time to be less than or equal to the given value - in: query name: task__end_time schema: type: string format: date-time description: Filter by the task end time to be equal to the given value - in: query name: task__end_time__gt schema: type: string format: date-time description: Filter by the task end time to be greater than the given value - in: query name: task__end_time__gte schema: type: string format: date-time description: >- Filter by the task end time to be greater than or equal to the given value - in: query name: task__end_time__lt schema: type: string format: date-time description: Filter by the task end time to be less than the given value - in: query name: task__end_time__lte schema: type: string format: date-time description: >- Filter by the task end time to be less than or equal to the given value - in: query name: task__priority schema: type: integer description: Filter by the task priority to be equal to the given value - in: query name: task__priority__gt schema: type: integer description: Filter by the task priority to be greater than the given value - in: query name: task__priority__gte schema: type: integer description: >- Filter by the task priority to be greater than or equal to the given value - in: query name: task__priority__lt schema: type: integer description: Filter by the task priority to be less than the given value - in: query name: task__priority__lte schema: type: integer description: >- Filter by the task priority to be less than or equal to the given value - in: query name: task__start_time schema: type: string format: date-time description: Filter by the task start time to be equal to the given value - in: query name: task__start_time__gt schema: type: string format: date-time description: Filter by the task start time to be greater than the given value - in: query name: task__start_time__gte schema: type: string format: date-time description: >- Filter by the task start time to be greater than or equal to the given value - in: query name: task__start_time__lt schema: type: string format: date-time description: Filter by the task start time to be less than the given value - in: query name: task__start_time__lte schema: type: string format: date-time description: >- Filter by the task start time to be less than or equal to the given value - in: query name: task__status schema: type: string x-spec-enum-id: 8c56477a743a3824 enum: - CANCELLED - EXPIRED - FAILED - FINALIZING - FULFILLED - LOCKED_IN - LOCK_IN_REQUESTED - LOCK_IN_TIMEOUT - PENDING - PENDING_CANCELLATION - PROCESSING - PUBLISHED - QUEUED - REQUESTED - REQUEST_RETRYING - WAITLISTED - WAITLIST_ABANDONED - WAITLIST_EXPIRED description: |- Filter by the task status to be equal to the given value * `PENDING` - Pending * `REQUESTED` - Requested * `FULFILLED` - Fulfilled * `CANCELLED` - Cancelled * `PROCESSING` - Processing * `QUEUED` - Queued * `EXPIRED` - Expired * `FINALIZING` - Finalizing * `LOCK_IN_REQUESTED` - Lock-In Requested * `LOCK_IN_TIMEOUT` - Lock-In Timeout * `LOCKED_IN` - Locked In * `PENDING_CANCELLATION` - Pending Cancellation * `FAILED` - Failed * `PUBLISHED` - Published * `WAITLISTED` - Waitlisted * `WAITLIST_ABANDONED` - Waitlist Abandoned * `WAITLIST_EXPIRED` - Waitlist Expired * `REQUEST_RETRYING` - Request Retrying - in: query name: task__status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: task__status__ne schema: type: string description: Filter by the task status to not be equal to the given value - in: query name: task__status__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: task_id schema: type: string format: uuid description: Filter by the task ID to be equal to the given value - in: query name: task_id__in schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: task_name schema: type: string description: Filter by the task name to be equal to the given value - in: query name: task_name__icontains schema: type: string description: >- Filter by the task name to contain the given value (case-insensitive) - in: query name: task_name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: task_name__ne schema: type: string description: Filter by the task name to not be equal to the given value - in: query name: task_name__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: test_quality_image schema: type: boolean description: Filter by the test quality image to be equal to the given value - in: query name: updated_time schema: type: string format: date-time description: Filter by the updated time to be equal to the given value - in: query name: updated_time__gt schema: type: string format: date-time description: Filter by the updated time to be greater than the given value - in: query name: updated_time__gte schema: type: string format: date-time description: >- Filter by the updated time to be greater than or equal to the given value - in: query name: updated_time__lt schema: type: string format: date-time description: Filter by the updated time to be less than the given value - in: query name: updated_time__lte schema: type: string format: date-time description: >- Filter by the updated time to be less than or equal to the given value tags: - Captures security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCaptureList' text/csv: schema: $ref: '#/components/schemas/PaginatedCaptureList' application/geo+json: schema: $ref: '#/components/schemas/PaginatedCaptureList' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/captures/{capture_id}/reviews/: post: operationId: tasking_v2_captures_reviews_create description: |- Create a capture review for a capture by its ID. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Open a capture review parameters: - in: path name: capture_id schema: type: string required: true - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Captures requestBody: content: application/json: schema: $ref: '#/components/schemas/CaptureReview' required: true security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CaptureReview' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/captures/{id}/: get: operationId: tasking_v2_captures_retrieve description: |- Retrieve details of a specific capture by its ID. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Capture parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid title: Capture ID description: A UUID string identifying this capture. required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Captures security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Capture' text/csv: schema: $ref: '#/components/schemas/Capture' application/geo+json: schema: $ref: '#/components/schemas/Capture' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/imaging-windows/: get: operationId: tasking_v2_imaging_windows_list description: >- Retrieve the available imaging windows after completing a synchronous (blocking) imaging window search using the `search_id` returned from the initial search request as a query parameter. This operation is deprecated. Please [create an asynchronous imaging windows search request](#tag/Imaging-Windows/operation/imaging-windows_search_create) instead. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Imaging Windows parameters: - in: query name: end_time schema: type: string format: date-time description: Filter by the end time to be equal to the given value - in: query name: end_time__gt schema: type: string format: date-time description: Filter by the end time to be greater than the given value - in: query name: end_time__gte schema: type: string format: date-time description: >- Filter by the end time to be greater than or equal to the given value - in: query name: end_time__lt schema: type: string format: date-time description: Filter by the end time to be less than the given value - in: query name: end_time__lte schema: type: string format: date-time description: Filter by the end time to be less than or equal to the given value - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - name: limit required: false in: query description: Number of results to return per page. schema: type: integer minimum: 1 maximum: 1000 - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer minimum: 0 maximum: 30000 - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: search_id schema: type: string format: uuid description: Filter by the search ID to be equal to the given value required: true - in: query name: search_request_id schema: type: string format: uuid title: Search Request ID description: Filter by the search request ID to be equal to the given value - in: query name: show_replacing_imaging_windows schema: type: boolean description: >- If true, the search results will include imaging windows that require the replacement of existing orders. If one of these imaging windows is used to submit an order, all orders listed in its `conflicting_orders` will be cancelled. - in: query name: show_waitlistable_imaging_windows schema: type: boolean description: >- If true, the search results will include imaging windows that are only available via waitlisting. If an imaging window with `only_via_waitlist=true` is used to submit an order, the order will remain in status `WAITLISTED` until the imaging window becomes available. - in: query name: start_time schema: type: string format: date-time description: Filter by the start time to be equal to the given value - in: query name: start_time__gt schema: type: string format: date-time description: Filter by the start time to be greater than the given value - in: query name: start_time__gte schema: type: string format: date-time description: >- Filter by the start time to be greater than or equal to the given value - in: query name: start_time__lt schema: type: string format: date-time description: Filter by the start time to be less than the given value - in: query name: start_time__lte schema: type: string format: date-time description: Filter by the start time to be less than or equal to the given value tags: - Imaging Windows security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedImagingWindowList' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' post: operationId: tasking_v2_imaging_windows_create description: >- Performs a synchronous (blocking) search for available imaging windows. The request will return only after all available imaging windows have been determined. This process may take up to two minutes. This operation is deprecated. Please [create an asynchronous imaging windows search request](#tag/Imaging-Windows/operation/imaging-windows_search_create) instead. ### Rate Limits * 3 requests/second (scope: `imaging window search`) * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Search Imaging Windows tags: - Imaging Windows requestBody: content: application/json: schema: $ref: '#/components/schemas/ImagingWindowSearchRequest' required: true security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] deprecated: true responses: '201': headers: Location: schema: type: string format: uri content: application/json: schema: $ref: '#/components/schemas/LocationResponse' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' '503': description: Imaging window search is currently unavailable. /tasking/v2/imaging-windows/search/: post: operationId: tasking_v2_imaging_windows_search_create description: >- Submit an asynchronous request to search for imaging windows. Once the search request has been created its status and results can be observed by retrieving the resource by its ID. Additional results will be returned over time as they become available until the status of the search request changes to `DONE`. ### Rate Limits * 3 requests/second (scope: `imaging window search`) * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Create Asynchronous Imaging Windows Search Request parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Imaging Windows requestBody: content: application/json: schema: $ref: '#/components/schemas/ImagingWindowSearchRequest' required: true security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ImagingWindowSearchDetails' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/imaging-windows/search/{id}/: get: operationId: tasking_v2_imaging_windows_search_retrieve description: >- Retrieve the status and results of an imaging window search request by its ID. Additional results will be returned over time as they become available until the status of the search request changes to `DONE`. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Asynchronous Imaging Windows Search Results parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: path name: id schema: type: string format: uuid title: Search Request ID description: UUID of the Imaging Window Search Request required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. - in: query name: show_replacing_imaging_windows schema: type: boolean description: >- If true, the search results will include imaging windows that require the replacement of existing orders. If one of these imaging windows is used to submit an order, all orders listed in its `conflicting_orders` will be cancelled. - in: query name: show_waitlistable_imaging_windows schema: type: boolean description: >- If true, the search results will include imaging windows that are only available via waitlisting. If an imaging window with `only_via_waitlist=true` is used to submit an order, the order will remain in status `WAITLISTED` until the imaging window becomes available. tags: - Imaging Windows security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImagingWindowSearchDetails' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/order-history/: get: operationId: tasking_v2_order_history_list description: >- List history events for all orders and captures that relate to the given filters. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: List Order History parameters: - in: query name: created_time schema: type: string format: date-time description: Filter by the created time to be equal to the given value - in: query name: created_time__gt schema: type: string format: date-time description: Filter by the created time to be greater than the given value - in: query name: created_time__gte schema: type: string format: date-time description: >- Filter by the created time to be greater than or equal to the given value - in: query name: created_time__lt schema: type: string format: date-time description: Filter by the created time to be less than the given value - in: query name: created_time__lte schema: type: string format: date-time description: >- Filter by the created time to be less than or equal to the given value - in: query name: event_type schema: type: string x-spec-enum-id: 958c4b7584095396 enum: - BULK_CREATED - BULK_FINISHED - CAPTURE_DERIVING - CAPTURE_FAILED - CAPTURE_L1A_PUBLISHED - CAPTURE_MANUALLY_ASSESSED - CAPTURE_NOT_COVERED - CAPTURE_PROCESSING - CAPTURE_PUBLISHED - CAPTURE_REVIEW_UPDATE - CAPTURE_SCHEDULED - DELIVERY_TASK_CANCELLED - DELIVERY_TASK_COMPLETED - DELIVERY_TASK_EXPIRED - DELIVERY_TASK_FAILED - DELIVERY_TASK_STARTED - EXPRESS_ORDER_IMAGING_WINDOW_CONFIRMATION_TIMEOUT - EXPRESS_ORDER_MAX_ATTEMPTS_REACHED - EXPRESS_ORDER_NO_IMAGING_WINDOW_FOUND - ORDER_CANCELLED - ORDER_CREATED - ORDER_EDITED - ORDER_EXPIRED - ORDER_EXPIRING_SOON - ORDER_FAILED - ORDER_FULFILLED - ORDER_LOCK_IN_CANCELLATION_FAILED - ORDER_LOCK_IN_CANCELLATION_REQUESTED - ORDER_LOCK_IN_CONFIRMED - ORDER_LOCK_IN_EXCEPTION - ORDER_LOCK_IN_FAILED - ORDER_LOCK_IN_FINALIZING - ORDER_LOCK_IN_REJECTED - ORDER_MONITORING_PARTIAL_FAILED - ORDER_PENDING - ORDER_REJECTED - ORDER_STARTED - ORDER_WAITLISTED - ORDER_WAITLIST_ABANDONED - ORDER_WAITLIST_EXPIRED description: >- Filter by the event type to be equal to the given value * `CAPTURE_MANUALLY_ASSESSED` - Capture Manually Assessed * `CAPTURE_SCHEDULED` - Capture Scheduled * `CAPTURE_PROCESSING` - Capture Processing * `CAPTURE_PUBLISHED` - Capture Published * `CAPTURE_DERIVING` - Capture Deriving * `CAPTURE_L1A_PUBLISHED` - Capture L1A Published * `CAPTURE_FAILED` - Capture Failed * `CAPTURE_NOT_COVERED` - Capture Not Covered * `BULK_CREATED` - Bulk Created * `BULK_FINISHED` - Bulk Finished * `ORDER_CANCELLED` - Order Cancelled * `ORDER_CREATED` - Order Created * `ORDER_FULFILLED` - Order Fulfilled * `ORDER_EDITED` - Order Edited * `ORDER_EXPIRED` - Order Expired * `ORDER_EXPIRING_SOON` - Order Expiring Soon * `ORDER_FAILED` - Order Failed * `ORDER_MONITORING_PARTIAL_FAILED` - Order Monitoring Partial Failed * `ORDER_REJECTED` - Order Rejected * `ORDER_LOCK_IN_CONFIRMED` - Order Lock-In Confirmed * `ORDER_LOCK_IN_FAILED` - Order Lock-In Failed * `ORDER_LOCK_IN_EXCEPTION` - Order Lock-In Exception * `ORDER_LOCK_IN_REJECTED` - Order Lock-In Rejected * `ORDER_LOCK_IN_FINALIZING` - Order Lock-In Finalizing * `ORDER_LOCK_IN_CANCELLATION_FAILED` - Order Lock-In Cancellation Failed * `ORDER_LOCK_IN_CANCELLATION_REQUESTED` - Order Lock-In Cancellation Requested * `ORDER_PENDING` - Order Pending * `ORDER_STARTED` - Order Started * `ORDER_WAITLISTED` - Order Waitlisted * `ORDER_WAITLIST_EXPIRED` - Order Waitlist Expired * `ORDER_WAITLIST_ABANDONED` - Order Waitlist Abandoned * `EXPRESS_ORDER_NO_IMAGING_WINDOW_FOUND` - Express Order No Imaging Window Found * `EXPRESS_ORDER_MAX_ATTEMPTS_REACHED` - Express Order Max Attempts Reached * `EXPRESS_ORDER_IMAGING_WINDOW_CONFIRMATION_TIMEOUT` - Express Order Imaging Window Confirmation Timeout * `CAPTURE_REVIEW_UPDATE` - Capture Review Update * `DELIVERY_TASK_STARTED` - The delivery process has started. * `DELIVERY_TASK_COMPLETED` - The delivery process has been completed. * `DELIVERY_TASK_FAILED` - The delivery process has failed. * `DELIVERY_TASK_CANCELLED` - The delivery process has been cancelled. * `DELIVERY_TASK_EXPIRED` - The delivery has expired. - in: query name: event_type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: event_type__ne schema: type: string description: Filter by the event type to not be equal to the given value - in: query name: event_type__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - name: limit required: false in: query description: Number of results to return per page. schema: type: integer minimum: 1 maximum: 1000 - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer minimum: 0 maximum: 30000 - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. - in: query name: order_id schema: type: string format: uuid description: Filter by the order ID to be equal to the given value - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: search required: false in: query description: A search term. schema: type: string - in: query name: target_id schema: type: string format: uuid description: Filter by the target ID to be equal to the given value - in: query name: target_id__in schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: target_id__ne schema: type: string format: uuid description: Filter by the target ID to not be equal to the given value - in: query name: target_id__notin schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: target_type schema: type: string description: Filter by the target type to be equal to the given value tags: - Order History security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedHistoryEventList' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/order-history/{id}/: get: operationId: tasking_v2_order_history_retrieve description: |- Return a specific history event related to the given ID. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Order History parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: path name: id schema: type: string format: uuid description: A UUID string identifying this history event. required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Order History security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HistoryEvent' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/orders/: get: operationId: tasking_v2_orders_list description: >- Retrieve all tasking orders you have access to. This includes all orders created within your organization. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: List Tasking Orders parameters: - in: query name: altitude schema: type: integer description: Filter by the altitude to be equal to the given value - in: query name: altitude__gt schema: type: integer description: Filter by the altitude to be greater than the given value - in: query name: altitude__gte schema: type: integer description: >- Filter by the altitude to be greater than or equal to the given value - in: query name: altitude__lt schema: type: integer description: Filter by the altitude to be less than the given value - in: query name: altitude__lte schema: type: integer description: Filter by the altitude to be less than or equal to the given value - in: query name: asset_types schema: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: >- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Filter by the asset types to be equal to the given value - in: query name: asset_types__in schema: type: array items: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: >- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Multiple values may be separated by commas. explode: false style: form - in: query name: asset_types__ne schema: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: >- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Filter by the asset types to not be equal to the given value - in: query name: asset_types__notin schema: type: array items: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: >- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Multiple values may be separated by commas. explode: false style: form - in: query name: assured_tasking_tier schema: type: string x-spec-enum-id: bdb1bbf393dbb2d1 enum: - EXPRESS - NOT_APPLICABLE - STANDARD description: |- Filter by the assured tasking tier to be equal to the given value * `NOT_APPLICABLE` - Not Applicable * `STANDARD` - Standard * `EXPRESS` - Express - in: query name: assured_tasking_tier__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: assured_tasking_tier__ne schema: type: string description: >- Filter by the assured tasking tier to not be equal to the given value - in: query name: assured_tasking_tier__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: cancellation_fee_applied schema: type: boolean description: >- Filter by the cancellation fee applied to be equal to the given value - in: query name: cancelled_by_replacement schema: type: boolean description: >- Filter by the cancelled by replacement to be equal to the given value - in: query name: cancelled_time schema: type: string format: date-time description: Filter by the cancelled time to be equal to the given value - in: query name: cancelled_time__gt schema: type: string format: date-time description: Filter by the cancelled time to be greater than the given value - in: query name: cancelled_time__gte schema: type: string format: date-time description: >- Filter by the cancelled time to be greater than or equal to the given value - in: query name: cancelled_time__lt schema: type: string format: date-time description: Filter by the cancelled time to be less than the given value - in: query name: cancelled_time__lte schema: type: string format: date-time description: >- Filter by the cancelled time to be less than or equal to the given value - in: query name: capture_assessment_invalid_count schema: type: integer description: >- Filter by the number of captures assessed invalid to be equal to the given value - in: query name: capture_assessment_invalid_count__gt schema: type: integer description: >- Filter by the number of captures assessed invalid to be greater than the given value - in: query name: capture_assessment_invalid_count__gte schema: type: integer description: >- Filter by the number of captures assessed invalid to be greater than or equal to the given value - in: query name: capture_assessment_invalid_count__lt schema: type: integer description: >- Filter by the number of captures assessed invalid to be less than the given value - in: query name: capture_assessment_invalid_count__lte schema: type: integer description: >- Filter by the number of captures assessed invalid to be less than or equal to the given value - in: query name: capture_assessment_success_count schema: type: integer description: >- Filter by the number of captures assessed successful to be equal to the given value - in: query name: capture_assessment_success_count__gt schema: type: integer description: >- Filter by the number of captures assessed successful to be greater than the given value - in: query name: capture_assessment_success_count__gte schema: type: integer description: >- Filter by the number of captures assessed successful to be greater than or equal to the given value - in: query name: capture_assessment_success_count__lt schema: type: integer description: >- Filter by the number of captures assessed successful to be less than the given value - in: query name: capture_assessment_success_count__lte schema: type: integer description: >- Filter by the number of captures assessed successful to be less than or equal to the given value - in: query name: capture_count schema: type: integer description: Filter by the capture count to be equal to the given value - in: query name: capture_count__gt schema: type: integer description: Filter by the capture count to be greater than the given value - in: query name: capture_count__gte schema: type: integer description: >- Filter by the capture count to be greater than or equal to the given value - in: query name: capture_count__lt schema: type: integer description: Filter by the capture count to be less than the given value - in: query name: capture_count__lte schema: type: integer description: >- Filter by the capture count to be less than or equal to the given value - in: query name: capture_status_deriving_count schema: type: integer description: >- Filter by the capture status deriving count to be equal to the given value - in: query name: capture_status_deriving_count__gt schema: type: integer description: >- Filter by the capture status deriving count to be greater than the given value - in: query name: capture_status_deriving_count__gte schema: type: integer description: >- Filter by the capture status deriving count to be greater than or equal to the given value - in: query name: capture_status_deriving_count__lt schema: type: integer description: >- Filter by the capture status deriving count to be less than the given value - in: query name: capture_status_deriving_count__lte schema: type: integer description: >- Filter by the capture status deriving count to be less than or equal to the given value - in: query name: capture_status_failed_count schema: type: integer description: >- Filter by the number of failed captures to be equal to the given value - in: query name: capture_status_failed_count__gt schema: type: integer description: >- Filter by the number of failed captures to be greater than the given value - in: query name: capture_status_failed_count__gte schema: type: integer description: >- Filter by the number of failed captures to be greater than or equal to the given value - in: query name: capture_status_failed_count__lt schema: type: integer description: >- Filter by the number of failed captures to be less than the given value - in: query name: capture_status_failed_count__lte schema: type: integer description: >- Filter by the number of failed captures to be less than or equal to the given value - in: query name: capture_status_processing_count schema: type: integer description: >- Filter by the number of processing captures to be equal to the given value - in: query name: capture_status_processing_count__gt schema: type: integer description: >- Filter by the number of processing captures to be greater than the given value - in: query name: capture_status_processing_count__gte schema: type: integer description: >- Filter by the number of processing captures to be greater than or equal to the given value - in: query name: capture_status_processing_count__lt schema: type: integer description: >- Filter by the number of processing captures to be less than the given value - in: query name: capture_status_processing_count__lte schema: type: integer description: >- Filter by the number of processing captures to be less than or equal to the given value - in: query name: capture_status_published_count schema: type: integer description: >- Filter by the number of published captures to be equal to the given value - in: query name: capture_status_published_count__gt schema: type: integer description: >- Filter by the number of published captures to be greater than the given value - in: query name: capture_status_published_count__gte schema: type: integer description: >- Filter by the number of published captures to be greater than or equal to the given value - in: query name: capture_status_published_count__lt schema: type: integer description: >- Filter by the number of published captures to be less than the given value - in: query name: capture_status_published_count__lte schema: type: integer description: >- Filter by the number of published captures to be less than or equal to the given value - in: query name: capture_status_queued_count schema: type: integer description: >- Filter by the number of queued captures to be equal to the given value - in: query name: capture_status_queued_count__gt schema: type: integer description: >- Filter by the number of queued captures to be greater than the given value - in: query name: capture_status_queued_count__gte schema: type: integer description: >- Filter by the number of queued captures to be greater than or equal to the given value - in: query name: capture_status_queued_count__lt schema: type: integer description: >- Filter by the number of queued captures to be less than the given value - in: query name: capture_status_queued_count__lte schema: type: integer description: >- Filter by the number of queued captures to be less than or equal to the given value - in: query name: cloud_cover_max__gt schema: type: number format: float description: >- Filter by the maximum cloud coverage to be greater than the given value - in: query name: cloud_cover_max__gte schema: type: number format: float description: >- Filter by the maximum cloud coverage to be greater than or equal to the given value - in: query name: cloud_cover_max__lt schema: type: number format: float description: Filter by the maximum cloud coverage to be less than the given value - in: query name: cloud_cover_max__lte schema: type: number format: float description: >- Filter by the maximum cloud coverage to be less than or equal to the given value - in: query name: cloud_cover_min__gt schema: type: number format: float description: >- Filter by the minimum cloud coverage to be greater than the given value - in: query name: cloud_cover_min__gte schema: type: number format: float description: >- Filter by the minimum cloud coverage to be greater than or equal to the given value - in: query name: cloud_cover_min__lt schema: type: number format: float description: Filter by the minimum cloud coverage to be less than the given value - in: query name: cloud_cover_min__lte schema: type: number format: float description: >- Filter by the minimum cloud coverage to be less than or equal to the given value - in: query name: cloud_threshold schema: type: number format: float description: Filter by the cloud threshold to be equal to the given value - in: query name: cloud_threshold__gt schema: type: number format: float description: Filter by the cloud threshold to be greater than the given value - in: query name: cloud_threshold__gte schema: type: number format: float description: >- Filter by the cloud threshold to be greater than or equal to the given value - in: query name: cloud_threshold__lt schema: type: number format: float description: Filter by the cloud threshold to be less than the given value - in: query name: cloud_threshold__lte schema: type: number format: float description: >- Filter by the cloud threshold to be less than or equal to the given value - in: query name: created_as_replacement schema: type: boolean description: Filter by the created as replacement to be equal to the given value - in: query name: created_as_waitlisted schema: type: boolean description: Filter by the created as waitlisted to be equal to the given value - in: query name: created_by schema: type: string description: Filter by the created by to be equal to the given value - in: query name: created_by__icontains schema: type: string description: >- Filter by the created by to contain the given value (case-insensitive) - in: query name: created_by__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: created_by__ne schema: type: string description: Filter by the created by to not be equal to the given value - in: query name: created_by__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: created_time schema: type: string format: date-time description: Filter by the created time to be equal to the given value - in: query name: created_time__gt schema: type: string format: date-time description: Filter by the created time to be greater than the given value - in: query name: created_time__gte schema: type: string format: date-time description: >- Filter by the created time to be greater than or equal to the given value - in: query name: created_time__lt schema: type: string format: date-time description: Filter by the created time to be less than the given value - in: query name: created_time__lte schema: type: string format: date-time description: >- Filter by the created time to be less than or equal to the given value - in: query name: customer_aoi_name schema: type: string description: Filter by the customer aoi name to be equal to the given value - in: query name: customer_aoi_name__icontains schema: type: string description: >- Filter by the customer aoi name to contain the given value (case-insensitive) - in: query name: customer_aoi_name__isnotnull schema: type: boolean description: Filter by the customer aoi name to not be null/unset - in: query name: customer_aoi_name__isnull schema: type: boolean description: Filter by the customer aoi name to be null/unset - in: query name: customer_aoi_name__ne schema: type: string description: Filter by the customer aoi name to not be equal to the given value - in: query name: customer_name schema: type: string description: Filter by the customer name to be equal to the given value - in: query name: customer_name__icontains schema: type: string description: >- Filter by the customer name to contain the given value (case-insensitive) - in: query name: customer_name__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: customer_name__ne schema: type: string description: Filter by the customer name to not be equal to the given value - in: query name: customer_name__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: customer_org_id schema: type: integer description: Filter by the customer org ID to be equal to the given value - in: query name: customer_org_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: customer_org_id__ne schema: type: integer description: Filter by the customer org ID to not be equal to the given value - in: query name: customer_org_id__notin schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: data_products schema: type: array items: enum: - HIGH_RESOLUTION_SCENES - HYPERSPECTRAL_SCENES - TANAGER_METHANE_DETECTION type: string description: |- * `HIGH_RESOLUTION_SCENES` - High Resolution Scenes * `HYPERSPECTRAL_SCENES` - Hyperspectral Scenes * `TANAGER_METHANE_DETECTION` - Tanager Methane Detection x-spec-enum-id: 7bb913a518381932 description: Filter by the data products to be equal to the given value - in: query name: data_products__in schema: type: array items: type: array items: enum: - HIGH_RESOLUTION_SCENES - HYPERSPECTRAL_SCENES - TANAGER_METHANE_DETECTION type: string description: |- * `HIGH_RESOLUTION_SCENES` - High Resolution Scenes * `HYPERSPECTRAL_SCENES` - Hyperspectral Scenes * `TANAGER_METHANE_DETECTION` - Tanager Methane Detection x-spec-enum-id: 7bb913a518381932 description: Multiple values may be separated by commas. explode: false style: form - in: query name: end_time schema: type: string format: date-time description: Filter by the end time to be equal to the given value - in: query name: end_time__gt schema: type: string format: date-time description: Filter by the end time to be greater than the given value - in: query name: end_time__gte schema: type: string format: date-time description: >- Filter by the end time to be greater than or equal to the given value - in: query name: end_time__lt schema: type: string format: date-time description: Filter by the end time to be less than the given value - in: query name: end_time__lte schema: type: string format: date-time description: Filter by the end time to be less than or equal to the given value - in: query name: ends_in_hours__exact schema: type: number description: Filter by the ends in hours to be equal to the given value - in: query name: ends_in_hours__gt schema: type: number description: Filter by the ends in hours to be greater than the given value - in: query name: ends_in_hours__gte schema: type: number description: >- Filter by the ends in hours to be greater than or equal to the given value - in: query name: ends_in_hours__lt schema: type: number description: Filter by the ends in hours to be less than the given value - in: query name: ends_in_hours__lte schema: type: number description: >- Filter by the ends in hours to be less than or equal to the given value - in: query name: estimated_quota_cost schema: type: number format: float description: Filter by the estimated quota cost to be equal to the given value - in: query name: estimated_quota_cost__gt schema: type: number format: float description: >- Filter by the estimated quota cost to be greater than the given value - in: query name: estimated_quota_cost__gte schema: type: number format: float description: >- Filter by the estimated quota cost to be greater than or equal to the given value - in: query name: estimated_quota_cost__lt schema: type: number format: float description: Filter by the estimated quota cost to be less than the given value - in: query name: estimated_quota_cost__lte schema: type: number format: float description: >- Filter by the estimated quota cost to be less than or equal to the given value - in: query name: exclusivity_days schema: type: integer description: Filter by the exclusivity days to be equal to the given value - in: query name: exclusivity_days__gt schema: type: integer description: Filter by the exclusivity days to be greater than the given value - in: query name: exclusivity_days__gte schema: type: integer description: >- Filter by the exclusivity days to be greater than or equal to the given value - in: query name: exclusivity_days__lt schema: type: integer description: Filter by the exclusivity days to be less than the given value - in: query name: exclusivity_days__lte schema: type: integer description: >- Filter by the exclusivity days to be less than or equal to the given value - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: format schema: type: string enum: - csv - json - in: query name: fulfilled_sqkm schema: type: number format: float description: >- Filter by the fulfilled square kilometers to be equal to the given value - in: query name: fulfilled_sqkm__gt schema: type: number format: float description: >- Filter by the fulfilled square kilometers to be greater than the given value - in: query name: fulfilled_sqkm__gte schema: type: number format: float description: >- Filter by the fulfilled square kilometers to be greater than or equal to the given value - in: query name: fulfilled_sqkm__lt schema: type: number format: float description: >- Filter by the fulfilled square kilometers to be less than the given value - in: query name: fulfilled_sqkm__lte schema: type: number format: float description: >- Filter by the fulfilled square kilometers to be less than or equal to the given value - in: query name: fulfilled_time schema: type: string format: date-time description: Filter by the fulfilled time to be equal to the given value - in: query name: fulfilled_time__gt schema: type: string format: date-time description: Filter by the fulfilled time to be greater than the given value - in: query name: fulfilled_time__gte schema: type: string format: date-time description: >- Filter by the fulfilled time to be greater than or equal to the given value - in: query name: fulfilled_time__lt schema: type: string format: date-time description: Filter by the fulfilled time to be less than the given value - in: query name: fulfilled_time__lte schema: type: string format: date-time description: >- Filter by the fulfilled time to be less than or equal to the given value - in: query name: geometry__centroid_within schema: type: string description: >- Filter by the geometry to have its centroid within the given geometry (GeoJSON or WKT string) - in: query name: geometry__intersects schema: type: string description: >- Filter by the geometry to to intersect with the given geometry (GeoJSON or WKT string) - in: query name: ground_sample_distance_max schema: type: number format: float description: >- Filter by the maximum ground sample distance to be equal to the given value - in: query name: ground_sample_distance_max__gt schema: type: number format: float description: >- Filter by the maximum ground sample distance to be greater than the given value - in: query name: ground_sample_distance_max__gte schema: type: number format: float description: >- Filter by the maximum ground sample distance to be greater than or equal to the given value - in: query name: ground_sample_distance_max__lt schema: type: number format: float description: >- Filter by the maximum ground sample distance to be less than the given value - in: query name: ground_sample_distance_max__lte schema: type: number format: float description: >- Filter by the maximum ground sample distance to be less than or equal to the given value - in: query name: has_unassessed_captures schema: type: boolean description: Filter by the has unassessed captures to be equal to the given value - in: query name: id schema: type: string format: uuid description: Filter by the id to be equal to the given value - in: query name: id__in schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: id__ne schema: type: string format: uuid description: Filter by the id to not be equal to the given value - in: query name: id__notin schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: imaging_conops schema: type: string x-spec-enum-id: de24a0cacb2de93e enum: - dark - experimental - flatfield - glint - high_capacity - high_data_volume - nominal - video description: >- Filter by the imaging collection preset to be equal to the given value * `nominal` - Nominal * `high_capacity` - High Capacity * `high_data_volume` - High Data Volume * `experimental` - Experimental * `dark` - Dark * `glint` - Glint * `flatfield` - Flatfield * `video` - Video - in: query name: imaging_conops__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: imaging_conops__ne schema: type: string description: >- Filter by the imaging collection preset to not be equal to the given value - in: query name: imaging_conops__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: last_acquired_time schema: type: string format: date-time description: Filter by the last acquired time to be equal to the given value - in: query name: last_acquired_time__gt schema: type: string format: date-time description: Filter by the last acquired time to be greater than the given value - in: query name: last_acquired_time__gte schema: type: string format: date-time description: >- Filter by the last acquired time to be greater than or equal to the given value - in: query name: last_acquired_time__lt schema: type: string format: date-time description: Filter by the last acquired time to be less than the given value - in: query name: last_acquired_time__lte schema: type: string format: date-time description: >- Filter by the last acquired time to be less than or equal to the given value - name: limit required: false in: query description: Number of results to return per page. schema: type: integer minimum: 1 maximum: 1000 - in: query name: listing schema: type: string x-spec-enum-id: 8e373a3b62777098 enum: - hotlisted - unlisted description: |- Filter by the hotlist to be equal to the given value * `unlisted` - Unlisted * `hotlisted` - Hotlisted - in: query name: listing__ne schema: type: string description: Filter by the hotlist to not be equal to the given value - in: query name: n_stereo_pov schema: type: integer x-spec-enum-id: 6f8bdde0f4f15994 nullable: true enum: - 2 - 3 description: >- Filter by the number of stereo captures to be equal to the given value * `2` - 2 * `3` - 3 - in: query name: n_stereo_pov__ne schema: type: integer description: >- Filter by the number of stereo captures to not be equal to the given value - in: query name: name schema: type: string description: Filter by the name to be equal to the given value - in: query name: name__icontains schema: type: string description: Filter by the name to contain the given value (case-insensitive) - in: query name: name__ne schema: type: string description: Filter by the name to not be equal to the given value - in: query name: name_ascii schema: type: string description: Filter by the name ascii to be equal to the given value - in: query name: name_ascii__icontains schema: type: string description: >- Filter by the name ascii to contain the given value (case-insensitive) - in: query name: name_ascii__ne schema: type: string description: Filter by the name ascii to not be equal to the given value - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer minimum: 0 maximum: 30000 - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. - in: query name: order_type schema: type: string x-spec-enum-id: 18df9b1d5988c26a enum: - IMAGE - STEREO - VIDEO description: |- Filter by the order type to be equal to the given value * `IMAGE` - Image * `VIDEO` - Video * `STEREO` - Stereo - in: query name: order_type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: order_type__ne schema: type: string description: Filter by the order type to not be equal to the given value - in: query name: order_type__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: original_geometry_type schema: type: string x-spec-enum-id: da81e9aa1a222391 enum: - GeometryCollection - LineString - MultiLineString - MultiPoint - MultiPolygon - Point - Polygon description: |- Filter by the original geometry type to be equal to the given value * `Point` - Point * `MultiPoint` - MultiPoint * `LineString` - LineString * `MultiLineString` - MultiLineString * `Polygon` - Polygon * `MultiPolygon` - MultiPolygon * `GeometryCollection` - GeometryCollection - in: query name: original_geometry_type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: original_geometry_type__ne schema: type: string description: >- Filter by the original geometry type to not be equal to the given value - in: query name: original_geometry_type__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: pending_quota_cost schema: type: number format: float description: Filter by the pending quota cost to be equal to the given value - in: query name: pending_quota_cost__gt schema: type: number format: float description: Filter by the pending quota cost to be greater than the given value - in: query name: pending_quota_cost__gte schema: type: number format: float description: >- Filter by the pending quota cost to be greater than or equal to the given value - in: query name: pending_quota_cost__lt schema: type: number format: float description: Filter by the pending quota cost to be less than the given value - in: query name: pending_quota_cost__lte schema: type: number format: float description: >- Filter by the pending quota cost to be less than or equal to the given value - in: query name: pl_number schema: type: string description: Filter by the contract number to be equal to the given value - in: query name: pl_number__icontains schema: type: string description: >- Filter by the contract number to contain the given value (case-insensitive) - in: query name: pl_number__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: pl_number__ne schema: type: string description: Filter by the contract number to not be equal to the given value - in: query name: pl_number__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: priority schema: type: integer description: Filter by the priority to be equal to the given value - in: query name: priority__gt schema: type: integer description: Filter by the priority to be greater than the given value - in: query name: priority__gte schema: type: integer description: >- Filter by the priority to be greater than or equal to the given value - in: query name: priority__lt schema: type: integer description: Filter by the priority to be less than the given value - in: query name: priority__lte schema: type: integer description: Filter by the priority to be less than or equal to the given value - in: query name: product schema: type: string description: Filter by the product name to be equal to the given value - in: query name: product__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: product__ne schema: type: string description: Filter by the product name to not be equal to the given value - in: query name: product__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: progress schema: type: number format: float description: Filter by the progress to be equal to the given value - in: query name: progress__gt schema: type: number format: float description: Filter by the progress to be greater than the given value - in: query name: progress__gte schema: type: number format: float description: >- Filter by the progress to be greater than or equal to the given value - in: query name: progress__lt schema: type: number format: float description: Filter by the progress to be less than the given value - in: query name: progress__lte schema: type: number format: float description: Filter by the progress to be less than or equal to the given value - in: query name: quota_units schema: type: string x-spec-enum-id: 40530f6084312f5d nullable: true enum: - CREDITS - SQKM description: |- Filter by the quota units to be equal to the given value * `SQKM` - Sqkm * `CREDITS` - Credits - in: query name: rank schema: type: integer description: Filter by the rank to be equal to the given value - in: query name: rank__gt schema: type: integer description: Filter by the rank to be greater than the given value - in: query name: rank__gte schema: type: integer description: Filter by the rank to be greater than or equal to the given value - in: query name: rank__lt schema: type: integer description: Filter by the rank to be less than the given value - in: query name: rank__lte schema: type: integer description: Filter by the rank to be less than or equal to the given value - in: query name: requested_sqkm schema: type: number format: float description: >- Filter by the requested square kilometers to be equal to the given value - in: query name: requested_sqkm__gt schema: type: number format: float description: >- Filter by the requested square kilometers to be greater than the given value - in: query name: requested_sqkm__gte schema: type: number format: float description: >- Filter by the requested square kilometers to be greater than or equal to the given value - in: query name: requested_sqkm__lt schema: type: number format: float description: >- Filter by the requested square kilometers to be less than the given value - in: query name: requested_sqkm__lte schema: type: number format: float description: >- Filter by the requested square kilometers to be less than or equal to the given value - in: query name: sat_azimuth_angle_max schema: type: number format: float description: >- Filter by the maximum satellite azimuth angle to be equal to the given value - in: query name: sat_azimuth_angle_max__gt schema: type: number format: float description: >- Filter by the maximum satellite azimuth angle to be greater than the given value - in: query name: sat_azimuth_angle_max__gte schema: type: number format: float description: >- Filter by the maximum satellite azimuth angle to be greater than or equal to the given value - in: query name: sat_azimuth_angle_max__lt schema: type: number format: float description: >- Filter by the maximum satellite azimuth angle to be less than the given value - in: query name: sat_azimuth_angle_max__lte schema: type: number format: float description: >- Filter by the maximum satellite azimuth angle to be less than or equal to the given value - in: query name: sat_azimuth_angle_min schema: type: number format: float description: >- Filter by the minimum satellite azimuth angle to be equal to the given value - in: query name: sat_azimuth_angle_min__gt schema: type: number format: float description: >- Filter by the minimum satellite azimuth angle to be greater than the given value - in: query name: sat_azimuth_angle_min__gte schema: type: number format: float description: >- Filter by the minimum satellite azimuth angle to be greater than or equal to the given value - in: query name: sat_azimuth_angle_min__lt schema: type: number format: float description: >- Filter by the minimum satellite azimuth angle to be less than the given value - in: query name: sat_azimuth_angle_min__lte schema: type: number format: float description: >- Filter by the minimum satellite azimuth angle to be less than or equal to the given value - in: query name: sat_elevation_angle_max schema: type: number format: float description: >- Filter by the maximum satellite elevation angle to be equal to the given value - in: query name: sat_elevation_angle_max__gt schema: type: number format: float description: >- Filter by the maximum satellite elevation angle to be greater than the given value - in: query name: sat_elevation_angle_max__gte schema: type: number format: float description: >- Filter by the maximum satellite elevation angle to be greater than or equal to the given value - in: query name: sat_elevation_angle_max__lt schema: type: number format: float description: >- Filter by the maximum satellite elevation angle to be less than the given value - in: query name: sat_elevation_angle_max__lte schema: type: number format: float description: >- Filter by the maximum satellite elevation angle to be less than or equal to the given value - in: query name: sat_elevation_angle_min schema: type: number format: float description: >- Filter by the minimum satellite elevation angle to be equal to the given value - in: query name: sat_elevation_angle_min__gt schema: type: number format: float description: >- Filter by the minimum satellite elevation angle to be greater than the given value - in: query name: sat_elevation_angle_min__gte schema: type: number format: float description: >- Filter by the minimum satellite elevation angle to be greater than or equal to the given value - in: query name: sat_elevation_angle_min__lt schema: type: number format: float description: >- Filter by the minimum satellite elevation angle to be less than the given value - in: query name: sat_elevation_angle_min__lte schema: type: number format: float description: >- Filter by the minimum satellite elevation angle to be less than or equal to the given value - in: query name: satellite_hw_ids schema: type: array items: type: string maxLength: 10 description: Filter by the satellite hw IDs to be equal to the given value - in: query name: satellite_hw_ids__in schema: type: array items: type: array items: type: string maxLength: 10 description: Multiple values may be separated by commas. explode: false style: form - in: query name: satellite_hw_ids__ne schema: type: array items: type: string maxLength: 10 description: Filter by the satellite hw IDs to not be equal to the given value - in: query name: satellite_hw_ids__notin schema: type: array items: type: array items: type: string maxLength: 10 description: Multiple values may be separated by commas. explode: false style: form - in: query name: satellite_types schema: type: array items: enum: - SKYSAT - PELICAN - TANAGER type: string description: |- * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager x-spec-enum-id: a084571859659279 description: Filter by the satellite types to be equal to the given value - in: query name: satellite_types__in schema: type: array items: type: array items: enum: - SKYSAT - PELICAN - TANAGER type: string description: |- * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager x-spec-enum-id: a084571859659279 description: Multiple values may be separated by commas. explode: false style: form - in: query name: scheduling_type schema: type: string x-spec-enum-id: 3d5d72179084691b enum: - ARCHIVE - ASSURED - EXPRESS - FLEXIBLE - LOCK_IN - MONITORING description: |- Filter by the scheduling type to be equal to the given value * `FLEXIBLE` - Flexible * `LOCK_IN` - Lock-In * `MONITORING` - Monitoring * `EXPRESS` - Express * `ASSURED` - Assured * `ARCHIVE` - Archive - in: query name: scheduling_type__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: scheduling_type__ne schema: type: string description: Filter by the scheduling type to not be equal to the given value - in: query name: scheduling_type__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: sensitivity_mode schema: type: string x-spec-enum-id: 164c294ecc3dfe16 enum: - GLINT - HIGH - MAX - MEDIUM - NOT_APPLICABLE - PUSHBROOM - STANDARD description: |- Filter by the sensitivity mode to be equal to the given value * `NOT_APPLICABLE` - Not Applicable * `GLINT` - Glint * `STANDARD` - Standard * `MEDIUM` - Medium * `HIGH` - High * `MAX` - Max * `PUSHBROOM` - Pushbroom - in: query name: sensitivity_mode__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: sensitivity_mode__ne schema: type: string description: Filter by the sensitivity mode to not be equal to the given value - in: query name: sensitivity_mode__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: solar_azimuth_angle_max schema: type: number format: float description: >- Filter by the maximum solar azimuth angle to be equal to the given value - in: query name: solar_azimuth_angle_max__gt schema: type: number format: float description: >- Filter by the maximum solar azimuth angle to be greater than the given value - in: query name: solar_azimuth_angle_max__gte schema: type: number format: float description: >- Filter by the maximum solar azimuth angle to be greater than or equal to the given value - in: query name: solar_azimuth_angle_max__lt schema: type: number format: float description: >- Filter by the maximum solar azimuth angle to be less than the given value - in: query name: solar_azimuth_angle_max__lte schema: type: number format: float description: >- Filter by the maximum solar azimuth angle to be less than or equal to the given value - in: query name: solar_azimuth_angle_min schema: type: number format: float description: >- Filter by the minimum solar azimuth angle to be equal to the given value - in: query name: solar_azimuth_angle_min__gt schema: type: number format: float description: >- Filter by the minimum solar azimuth angle to be greater than the given value - in: query name: solar_azimuth_angle_min__gte schema: type: number format: float description: >- Filter by the minimum solar azimuth angle to be greater than or equal to the given value - in: query name: solar_azimuth_angle_min__lt schema: type: number format: float description: >- Filter by the minimum solar azimuth angle to be less than the given value - in: query name: solar_azimuth_angle_min__lte schema: type: number format: float description: >- Filter by the minimum solar azimuth angle to be less than or equal to the given value - in: query name: solar_zenith_angle_max schema: type: number format: float description: >- Filter by the maximum solar zenith angle to be equal to the given value - in: query name: solar_zenith_angle_max__gt schema: type: number format: float description: >- Filter by the maximum solar zenith angle to be greater than the given value - in: query name: solar_zenith_angle_max__gte schema: type: number format: float description: >- Filter by the maximum solar zenith angle to be greater than or equal to the given value - in: query name: solar_zenith_angle_max__lt schema: type: number format: float description: >- Filter by the maximum solar zenith angle to be less than the given value - in: query name: solar_zenith_angle_max__lte schema: type: number format: float description: >- Filter by the maximum solar zenith angle to be less than or equal to the given value - in: query name: solar_zenith_angle_min schema: type: number format: float description: >- Filter by the minimum solar zenith angle to be equal to the given value - in: query name: solar_zenith_angle_min__gt schema: type: number format: float description: >- Filter by the minimum solar zenith angle to be greater than the given value - in: query name: solar_zenith_angle_min__gte schema: type: number format: float description: >- Filter by the minimum solar zenith angle to be greater than or equal to the given value - in: query name: solar_zenith_angle_min__lt schema: type: number format: float description: >- Filter by the minimum solar zenith angle to be less than the given value - in: query name: solar_zenith_angle_min__lte schema: type: number format: float description: >- Filter by the minimum solar zenith angle to be less than or equal to the given value - in: query name: start_time schema: type: string format: date-time description: Filter by the start time to be equal to the given value - in: query name: start_time__gt schema: type: string format: date-time description: Filter by the start time to be greater than the given value - in: query name: start_time__gte schema: type: string format: date-time description: >- Filter by the start time to be greater than or equal to the given value - in: query name: start_time__lt schema: type: string format: date-time description: Filter by the start time to be less than the given value - in: query name: start_time__lte schema: type: string format: date-time description: Filter by the start time to be less than or equal to the given value - in: query name: status schema: type: string x-spec-enum-id: ce5b6ce9e674887f enum: - CANCELLED - EXPIRED - FAILED - FINALIZING - FULFILLED - IN_PROGRESS - PENDING - PENDING_CANCELLATION - RECEIVED - REJECTED - REQUESTED - WAITLISTED - WAITLIST_ABANDONED - WAITLIST_EXPIRED description: |- Filter by the status to be equal to the given value * `RECEIVED` - Received * `PENDING` - Pending * `IN_PROGRESS` - In Progress * `EXPIRED` - Expired * `FULFILLED` - Fulfilled * `FAILED` - Failed * `CANCELLED` - Cancelled * `REQUESTED` - Requested * `FINALIZING` - Finalizing * `PENDING_CANCELLATION` - Pending Cancellation * `REJECTED` - Rejected * `WAITLISTED` - Waitlisted * `WAITLIST_ABANDONED` - Waitlist Abandoned * `WAITLIST_EXPIRED` - Waitlist Expired - in: query name: status__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: status__ne schema: type: string description: Filter by the status to not be equal to the given value - in: query name: status__notin schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: target_coverage_min schema: type: number format: float description: Filter by the target coverage min to be equal to the given value - in: query name: target_coverage_min__gt schema: type: number format: float description: Filter by the target coverage min to be greater than the given value - in: query name: target_coverage_min__gte schema: type: number format: float description: >- Filter by the target coverage min to be greater than or equal to the given value - in: query name: target_coverage_min__lt schema: type: number format: float description: Filter by the target coverage min to be less than the given value - in: query name: target_coverage_min__lte schema: type: number format: float description: >- Filter by the target coverage min to be less than or equal to the given value - in: query name: task_count schema: type: integer description: Filter by the task count to be equal to the given value - in: query name: task_count__gt schema: type: integer description: Filter by the task count to be greater than the given value - in: query name: task_count__gte schema: type: integer description: >- Filter by the task count to be greater than or equal to the given value - in: query name: task_count__lt schema: type: integer description: Filter by the task count to be less than the given value - in: query name: task_count__lte schema: type: integer description: Filter by the task count to be less than or equal to the given value - in: query name: total_delivered_sqkm schema: type: number format: float description: >- Filter by the total delivered square kilometers to be equal to the given value - in: query name: total_delivered_sqkm__gt schema: type: number format: float description: >- Filter by the total delivered square kilometers to be greater than the given value - in: query name: total_delivered_sqkm__gte schema: type: number format: float description: >- Filter by the total delivered square kilometers to be greater than or equal to the given value - in: query name: total_delivered_sqkm__lt schema: type: number format: float description: >- Filter by the total delivered square kilometers to be less than the given value - in: query name: total_delivered_sqkm__lte schema: type: number format: float description: >- Filter by the total delivered square kilometers to be less than or equal to the given value - in: query name: updated_time schema: type: string format: date-time description: Filter by the updated time to be equal to the given value - in: query name: updated_time__gt schema: type: string format: date-time description: Filter by the updated time to be greater than the given value - in: query name: updated_time__gte schema: type: string format: date-time description: >- Filter by the updated time to be greater than or equal to the given value - in: query name: updated_time__lt schema: type: string format: date-time description: Filter by the updated time to be less than the given value - in: query name: updated_time__lte schema: type: string format: date-time description: >- Filter by the updated time to be less than or equal to the given value - in: query name: used_quota schema: type: number format: float description: Filter by the used quota to be equal to the given value - in: query name: used_quota__gt schema: type: number format: float description: Filter by the used quota to be greater than the given value - in: query name: used_quota__gte schema: type: number format: float description: >- Filter by the used quota to be greater than or equal to the given value - in: query name: used_quota__lt schema: type: number format: float description: Filter by the used quota to be less than the given value - in: query name: used_quota__lte schema: type: number format: float description: Filter by the used quota to be less than or equal to the given value - in: query name: user_id schema: type: integer description: Filter by the user ID to be equal to the given value - in: query name: user_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: user_id__ne schema: type: integer description: Filter by the user ID to not be equal to the given value - in: query name: user_id__notin schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: user_org_id schema: type: integer description: Filter by the user org ID to be equal to the given value - in: query name: user_org_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: user_org_id__ne schema: type: integer description: Filter by the user org ID to not be equal to the given value - in: query name: user_org_id__notin schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form tags: - Orders security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedOrderList' text/csv: schema: $ref: '#/components/schemas/PaginatedOrderList' application/geo+json: schema: $ref: '#/components/schemas/PaginatedOrderList' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' post: operationId: tasking_v2_orders_create description: |- Submit a new tasking order. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Create Tasking Order parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: format schema: type: string enum: - csv - json - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Orders requestBody: content: application/json: schema: $ref: '#/components/schemas/Order' required: true security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Order' text/csv: schema: $ref: '#/components/schemas/Order' application/geo+json: schema: $ref: '#/components/schemas/Order' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/orders/{id}/: get: operationId: tasking_v2_orders_retrieve description: |- Retrieve details of a specific tasking order by its ID. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Tasking Order parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid title: Order ID description: A UUID string identifying this order. required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Orders security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderDetail' text/csv: schema: $ref: '#/components/schemas/OrderDetail' application/geo+json: schema: $ref: '#/components/schemas/OrderDetail' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' put: operationId: tasking_v2_orders_update description: >- Change the properties of a tasking order by its ID. Changes may be prohibited by certain conditions under your contract's Terms of Service, for example if an order is already in status `IN_PROGRESS`. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Update Tasking Order parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid title: Order ID description: A UUID string identifying this order. required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Orders requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOrder' security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateOrder' text/csv: schema: $ref: '#/components/schemas/UpdateOrder' application/geo+json: schema: $ref: '#/components/schemas/UpdateOrder' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' delete: operationId: tasking_v2_orders_destroy description: >- Cancel an existing tasking order. An order is cancellable if `is_cancellable=true`. Cancellation may be prohibited by certain conditions under your contract's Terms of Service, for example if an order is already in status `IN_PROGRESS`. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Cancel Tasking Order parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid title: Order ID description: A UUID string identifying this order. required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Orders security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '204': description: No response body '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/orders/{id}/pricing/: get: operationId: tasking_v2_orders_pricing_retrieve description: >- Retrieve detailed pricing information for a specific tasking order by its ID. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Order Pricing Information parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid title: Order ID description: A UUID string identifying this order. required: true - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Orders - Pricing security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderPricingDetails' text/csv: schema: $ref: '#/components/schemas/OrderPricingDetails' application/geo+json: schema: $ref: '#/components/schemas/OrderPricingDetails' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/preferences/: get: operationId: tasking_v2_preferences_retrieve description: |- Retrieve the tasking preferences for the current user. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Tasking Preferences parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Preferences security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserTaskingPreferences' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' put: operationId: tasking_v2_preferences_update description: |- Update the tasking preferences for the current user. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Update Tasking Preferences parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Preferences requestBody: content: application/json: schema: $ref: '#/components/schemas/UserTaskingPreferences' required: true security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserTaskingPreferences' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/preferences/notifications/: get: operationId: tasking_v2_preferences_notifications_list description: |- List the email notification preferences for the current user. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: List Notification Preferences parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string tags: - Preferences security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/EmailNotification' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' post: operationId: tasking_v2_preferences_notifications_create description: |- Set the email notification preferences for the current user. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Set Notification Preferences parameters: - in: query name: fields schema: type: string description: >- Comma-separated list of fields to include in the response. If not provided, all available fields are returned. - in: query name: omit schema: type: string description: >- Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned. tags: - Preferences requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotification' required: true security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EmailNotification' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' /tasking/v2/pricing/: post: operationId: tasking_v2_pricing_create description: |- Retrieve a preview pricing details based on the given order parameters. ### Rate Limits * 300 requests/minute (scope: `sustained`) * 40 requests/second (scope: `burst`) summary: Retrieve Pricing Preview tags: - Pricing requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderPricingRequest' security: - BearerTokenAuth: [] - ApiKeyBasicAuth: [] - ApiKeyInAuthorizationHeaderAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PricingDetails' description: '' '400': description: Invalid request. '401': description: Unauthorized. '403': description: Insufficient privileges. '429': description: Request throttled (too many requests). headers: Retry-After: $ref: '#/components/headers/Retry-After' components: schemas: BulkOrderPricingDetails: type: object properties: total_estimated_quota_cost: type: number format: double nullable: true pricing_details: type: array items: $ref: '#/components/schemas/BulkOrderPricingItem' required: - pricing_details BulkOrderPricingItem: type: object properties: order_id: type: string format: uuid nullable: true description: Unique identifier of an order units: enum: - SQKM - CREDITS - null type: string description: |- * `SQKM` - Sqkm * `CREDITS` - Credits x-spec-enum-id: 40530f6084312f5d nullable: true estimated_quota_cost: type: number format: double nullable: true determined_by: enum: - pricing_model - replaced_orders - dedicated_capacity - null type: string description: |- * `pricing_model` - Pricing Model * `replaced_orders` - Replaced Orders * `dedicated_capacity` - Dedicated Capacity x-spec-enum-id: c799a2ec2d23c39d nullable: true pricing_model: allOf: - $ref: '#/components/schemas/PricingModel' nullable: true replaced_orders: type: array items: $ref: '#/components/schemas/ReplacedOrder' nullable: true readOnly: true message: type: object additionalProperties: {} nullable: true required: - replaced_orders BulkProcess: type: object properties: order_payloads: type: array items: $ref: '#/components/schemas/OrderPayload' writeOnly: true id: type: string format: uuid title: Bulk ID description: Unique identifier of a bulk process operation_type: enum: - CREATE - CANCEL - EDIT type: string x-spec-enum-id: 4ffaf3c0286272d8 description: |- Operation type of the bulk process * `CREATE` - Create * `CANCEL` - Cancel * `EDIT` - Edit required: - order_payloads BulkSummary: type: object properties: id: type: string format: uuid title: Bulk ID description: Unique identifier of a bulk process start_time: type: string format: date-time description: Time when the process was started end_time: type: string format: date-time nullable: true description: Time when all payloads have been processed operation_type: enum: - CREATE - CANCEL - EDIT type: string x-spec-enum-id: 4ffaf3c0286272d8 description: |- Operation type of the bulk process * `CREATE` - Create * `CANCEL` - Cancel * `EDIT` - Edit payload_count: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true description: >- Total number of order payloads that were submitted in the bulk process status: enum: - PENDING - RUNNING - COMPLETE type: string x-spec-enum-id: eede9d8905deb3d9 description: |- Overall status of the bulk process * `PENDING` - Pending * `RUNNING` - Running * `COMPLETE` - Complete processing_payload_count: type: integer maximum: 2147483647 minimum: -2147483648 description: Number of payloads currently being processed failed_payload_count: type: integer maximum: 2147483647 minimum: -2147483648 description: Number of payloads that have failed processing successful_payload_count: type: integer maximum: 2147483647 minimum: -2147483648 description: Number of payloads that have been processed successfully Capture: type: object properties: id: type: string format: uuid title: Capture ID description: Unique identifier of a capture order_id: type: string format: uuid description: Unique identifier of the parent order captured_area: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 description: GeoJSON representation of the area where the satellite captured data area_of_interest: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 description: >- GeoJSON representation of the area of interest to be covered by the capture after acquisition fulfilling: type: boolean description: >- Identifies the capture as fulfilling per the order's cloud coverage requirements and image quality assessments status: enum: - SCHEDULED - REMOVED - QUEUED - PROCESSING - FAILED - DERIVING - PUBLISHED type: string x-spec-enum-id: e2d271cbd0336dfc description: >- Acquisition status of the capture. Possible values are: * `SCHEDULED`/`QUEUED`: The capture has been scheduled for acquisition on a satellite * `PROCESSING`: The capture has been downlinked and is being processed * `DERIVING`: The capture has been published, but some requested assets are still being processed * `PUBLISHED`: The capture is available for download in our item store * `FAILED`: A failure occurred while acquiring or processing the imagery * `SCHEDULED` - Scheduled * `REMOVED` - Removed * `QUEUED` - Queued * `PROCESSING` - Processing * `FAILED` - Failed * `DERIVING` - Deriving * `PUBLISHED` - Published ground_id: type: string format: uuid readOnly: true description: >- Ground ID of the capture. Can be used to match the captures of a Stereo Tasking order. item_ids: type: array items: type: string readOnly: true description: >- Item IDs associated with the capture. Can be used to access the imagery through other systems such as the [Planet Orders API](https://developers.planet.com/apis/orders/). scene_ids: type: array items: type: string readOnly: true description: >- Scene IDs associated with the capture. Can be used to access the imagery through other systems such as the [Planet Orders API](https://developers.planet.com/apis/orders/). cloud_cover: type: number format: double maximum: 1 minimum: 0 description: Ratio of cloud cover over the area of interest of the capture order_name: type: string readOnly: true description: Name of the parent order order__status: enum: - RECEIVED - PENDING - IN_PROGRESS - EXPIRED - FULFILLED - FAILED - CANCELLED - REQUESTED - FINALIZING - PENDING_CANCELLATION - REJECTED - WAITLISTED - WAITLIST_ABANDONED - WAITLIST_EXPIRED type: string x-spec-enum-id: ce5b6ce9e674887f readOnly: true description: |- Status of the parent order * `RECEIVED` - Received * `PENDING` - Pending * `IN_PROGRESS` - In Progress * `EXPIRED` - Expired * `FULFILLED` - Fulfilled * `FAILED` - Failed * `CANCELLED` - Cancelled * `REQUESTED` - Requested * `FINALIZING` - Finalizing * `PENDING_CANCELLATION` - Pending Cancellation * `REJECTED` - Rejected * `WAITLISTED` - Waitlisted * `WAITLIST_ABANDONED` - Waitlist Abandoned * `WAITLIST_EXPIRED` - Waitlist Expired evaluation: enum: - NONE - SUCCESS - INVALID type: string x-spec-enum-id: 5bd1a88f0e6c6778 readOnly: true description: >- Final evaluation result after image quality assessments (automatic and manual) and capture review * `NONE` - None * `SUCCESS` - Success * `INVALID` - Invalid delivered_asset_types: type: array items: type: string readOnly: true description: > List of asset types that have been delivered for the capture, possible values are: * `basic_radiance_hdf5` * `ortho_radiance_hdf5` * `ortho_ql_ch4` * `ql_ch4_json` * `ortho_visual` * `ortho_beta_udm` * `recent_monthly_basemap"` * `ortho_qc_ch4` * `qc_ch4_json` created_time: type: string format: date-time readOnly: true description: Time the capture was first registered in the tasking systems updated_time: type: string format: date-time nullable: true description: Time the capture was last updated planned_acquisition_time: type: string format: date-time nullable: true description: Planned time of imagery acquisition acquired_time: type: string format: date-time nullable: true description: Time of imagery acquisition published_time: type: string format: date-time nullable: true title: Published to customer description: Time at which the captured imagery was published status_description: type: string nullable: true description: Additional description of the capture's status assessment: enum: - SUCCESS - ATTEMPT - INVALID - null type: string x-spec-enum-id: 69697b3f82cb370b nullable: true description: |- Result of the image quality assessment * `SUCCESS` - Success * `ATTEMPT` - Attempt * `INVALID` - Invalid assessment_time: type: string format: date-time nullable: true description: Time when the order was assessed for image quality pl_number: type: string title: Contract number description: >- Contract number of the search request. Required if you have access to multiple products or contracts. product: type: string title: Product name description: >- Name of the product of the search request. Required if you have access to multiple products or contracts. strip_id: type: string nullable: true description: >- ID of the imagery strip captured by the satellite passing over its target. The format of the ID uniquely identifies the imagery and can be used to access the imagery through other systems such as the [Planet Orders API](https://developers.planet.com/apis/orders/). item_types: type: array items: type: string nullable: true description: Types of items associated with the capture satellite_type: enum: - SKYSAT - PELICAN - TANAGER type: string x-spec-enum-id: a084571859659279 description: |- Satellite type of the capture * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager downloadable: type: boolean description: >- Indicates whether the captured imagery is available for direct download required: - area_of_interest - captured_area - created_time - delivered_asset_types - evaluation - fulfilling - ground_id - item_ids - order__status - order_id - order_name - pl_number - product - satellite_type - scene_ids - status CaptureReview: type: object properties: id: type: string format: uuid readOnly: true created_time: type: string format: date-time readOnly: true updated_time: type: string format: date-time readOnly: true review_type: enum: - REJECTION - APPROVAL type: string description: |- * `REJECTION` - Rejection * `APPROVAL` - Approval x-spec-enum-id: 2812c6cd84676f0d default: REJECTION capture_id: type: string format: uuid status: enum: - PENDING - IN_PROGRESS - PROCESSED type: string description: |- * `PENDING` - Pending * `IN_PROGRESS` - In Progress * `PROCESSED` - Processed x-spec-enum-id: 32487bc51a00e681 readOnly: true category: enum: - CLOUD_COVER - HAZE - DISPLACEMENT - BRIGHTNESS_ISSUE - SHADOWS - OTHER type: string description: |- * `CLOUD_COVER` - Cloud Coverage * `HAZE` - Haze * `DISPLACEMENT` - Gaps / Misalignment * `BRIGHTNESS_ISSUE` - Brightness Issue * `SHADOWS` - Shadows * `OTHER` - Other x-spec-enum-id: e012190807032446 created_by_user_id: type: string format: uuid readOnly: true geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 description: type: string default: '' jira_ticket_id: type: string nullable: true resolution: enum: - DECLINED - CAPTURE_INVALIDATED - QUOTA_ADJUSTED - REPROCESSED - ACCEPTED type: string description: |- * `DECLINED` - Declined * `CAPTURE_INVALIDATED` - Capture Invalidated * `QUOTA_ADJUSTED` - Quota Adjusted * `REPROCESSED` - Reprocessed * `ACCEPTED` - Accepted x-spec-enum-id: 25c4a3c6eb9980d8 readOnly: true outcome: enum: - DECLINED - REFUNDED - RE_TASKED - QUOTA_ADJUSTED - REPROCESSED - ACCEPTED type: string description: |- * `DECLINED` - Declined * `REFUNDED` - Refunded * `RE_TASKED` - Re-tasked * `QUOTA_ADJUSTED` - Quota Adjusted * `REPROCESSED` - Reprocessed * `ACCEPTED` - Accepted x-spec-enum-id: 4ad54c4f079f113a readOnly: true tags: nullable: true required: - capture_id - created_by_user_id - created_time - id - outcome - resolution - status - updated_time CloudForecast: type: object properties: start_time: type: string format: date-time readOnly: true end_time: type: string format: date-time readOnly: true prediction: type: number format: double maximum: 100 minimum: 0 readOnly: true nullable: true historical: type: number format: double maximum: 100 minimum: 0 readOnly: true nullable: true deprecated: true error_message: type: string readOnly: true nullable: true deprecated: true updated_time: type: string format: date-time readOnly: true required: - end_time - error_message - historical - prediction - start_time - updated_time ConflictingOrder: type: object properties: id: type: string format: uuid readOnly: true title: Order ID description: Unique identifier of an order name: type: string readOnly: true description: User-defined name of an order min_off_nadir: type: number format: double nullable: true description: Minimum off-nadir angle of the satellite satellite_elevation_angle_max: type: number format: double nullable: true description: Maximum elevation of the satellite to acquire imagery for the order cloud_forecast: type: array items: $ref: '#/components/schemas/CloudForecast' readOnly: true nullable: true description: >- Predicted cloud cover for the order. The forecast will be updated periodically, and the array will contain multiple forecast results in chronological order. Only available for Assured Tasking orders. assured_tasking_tier: enum: - NOT_APPLICABLE - STANDARD - EXPRESS type: string x-spec-enum-id: bdb1bbf393dbb2d1 readOnly: true description: |- Tier as determined by the imaging window of an Assured Tasking order * `NOT_APPLICABLE` - Not Applicable * `STANDARD` - Standard * `EXPRESS` - Express required: - assured_tasking_tier - cloud_forecast - id - name EmailNotification: type: object properties: enabled_emails: type: array items: enum: - ORDER_FULFILLED - ORDER_EXPIRED - ORDER_EXPIRING_SOON - ORDER_CREATED - ORDER_REJECTED - CAPTURE_FAILED - CAPTURE_PUBLISHED - CAPTURE_DERIVING - CAPTURE_L1A_PUBLISHED - CAPTURE_SCHEDULED - ORDER_LOCK_IN_CONFIRMED - ORDER_LOCK_IN_CANCELLATION_FAILED - ORDER_LOCK_IN_FAILED - ORDER_LOCK_IN_EXCEPTION - ORDER_LOCK_IN_REJECTED - BULK_FINISHED - CAPTURE_REVIEW_UPDATE - ORDER_FAILED - ORDER_WAITLISTED - ORDER_WAITLIST_EXPIRED - ORDER_WAITLIST_ABANDONED - DELIVERY_TASK_STARTED - DELIVERY_TASK_COMPLETED - DELIVERY_TASK_FAILED - DELIVERY_TASK_EXPIRED - DELIVERY_TASK_CANCELLED type: string description: >- * `ORDER_FULFILLED` - Order Fulfilled * `ORDER_EXPIRED` - Order Expired * `ORDER_EXPIRING_SOON` - Order Expiring Soon * `ORDER_CREATED` - Order Created * `ORDER_REJECTED` - Order Rejected * `CAPTURE_FAILED` - Capture Failed * `CAPTURE_PUBLISHED` - Capture Published * `CAPTURE_DERIVING` - Capture Deriving * `CAPTURE_L1A_PUBLISHED` - Capture L1A Published * `CAPTURE_SCHEDULED` - Capture Scheduled * `ORDER_LOCK_IN_CONFIRMED` - Order Lock-In Confirmed * `ORDER_LOCK_IN_CANCELLATION_FAILED` - Order Lock-In Cancellation Failed * `ORDER_LOCK_IN_FAILED` - Order Lock-In Failed * `ORDER_LOCK_IN_EXCEPTION` - Order Lock-In Exception * `ORDER_LOCK_IN_REJECTED` - Order Lock-In Rejected * `BULK_FINISHED` - Bulk Finished * `CAPTURE_REVIEW_UPDATE` - Capture Review Update * `ORDER_FAILED` - Order Failed * `ORDER_WAITLISTED` - Order Waitlisted * `ORDER_WAITLIST_EXPIRED` - Order Waitlist Expired * `ORDER_WAITLIST_ABANDONED` - Order Waitlist Abandoned * `DELIVERY_TASK_STARTED` - The delivery process has started. * `DELIVERY_TASK_COMPLETED` - The delivery process has been completed. * `DELIVERY_TASK_FAILED` - The delivery process has failed. * `DELIVERY_TASK_EXPIRED` - The delivery has expired. * `DELIVERY_TASK_CANCELLED` - The delivery process has been cancelled. x-spec-enum-id: b4d256536d0c6fbe description: >- Events for which email notifications are enabled. Possible values are listed under `event_type` on [Retrieve Order History](#tag/Order-History/operation/order-history_read). required: - enabled_emails Geometry: type: object properties: geojson: description: GeoJSON representation of the geometry required: - geojson HistoryEvent: type: object properties: id: type: string format: uuid description: Unique identifier of a history event target_type: type: string readOnly: true description: >- Object type this event applies to. Can be one of `Order`, `Capture`, or `BulkProcess`. user_email: type: string readOnly: true description: >- The user that triggered the event to be created. For most event types this defaults to the user who created the order. message: type: string readOnly: true description: A message describing the event data: readOnly: true nullable: true description: >- Additional properties of the history event. Properties are event type specific. target_id: type: string format: uuid description: Unique identifier of the object the event applies to event_type: enum: - CAPTURE_MANUALLY_ASSESSED - CAPTURE_SCHEDULED - CAPTURE_PROCESSING - CAPTURE_PUBLISHED - CAPTURE_DERIVING - CAPTURE_L1A_PUBLISHED - CAPTURE_FAILED - CAPTURE_NOT_COVERED - BULK_CREATED - BULK_FINISHED - ORDER_CANCELLED - ORDER_CREATED - ORDER_FULFILLED - ORDER_EDITED - ORDER_EXPIRED - ORDER_EXPIRING_SOON - ORDER_FAILED - ORDER_MONITORING_PARTIAL_FAILED - ORDER_REJECTED - ORDER_LOCK_IN_CONFIRMED - ORDER_LOCK_IN_FAILED - ORDER_LOCK_IN_EXCEPTION - ORDER_LOCK_IN_REJECTED - ORDER_LOCK_IN_FINALIZING - ORDER_LOCK_IN_CANCELLATION_FAILED - ORDER_LOCK_IN_CANCELLATION_REQUESTED - ORDER_PENDING - ORDER_STARTED - ORDER_WAITLISTED - ORDER_WAITLIST_EXPIRED - ORDER_WAITLIST_ABANDONED - EXPRESS_ORDER_NO_IMAGING_WINDOW_FOUND - EXPRESS_ORDER_MAX_ATTEMPTS_REACHED - EXPRESS_ORDER_IMAGING_WINDOW_CONFIRMATION_TIMEOUT - CAPTURE_REVIEW_UPDATE - DELIVERY_TASK_STARTED - DELIVERY_TASK_COMPLETED - DELIVERY_TASK_FAILED - DELIVERY_TASK_CANCELLED - DELIVERY_TASK_EXPIRED type: string x-spec-enum-id: 958c4b7584095396 description: >- The type of event. Possible values are: * `CAPTURE_MANUALLY_ASSESSED`: A capture was manually assessed for image quality * `CAPTURE_SCHEDULED`: A capture was scheduled for acquisition on a satellite * `CAPTURE_PROCESSING`: A capture was downlinked and is being processed * `CAPTURE_PUBLISHED`: A capture was published and is available for download * `CAPTURE_DERIVING`: Some of the requested assets of a capture were published and are available for download * `CAPTURE_L1A_PUBLISHED`: The non-orthorectified (L1A) assets of a capture were published and are available for download * `CAPTURE_FAILED`: A failure occurred while acquiring or processing the imagery of a capture * `CAPTURE_NOT_COVERED`: A capture was not sufficiently covered by published items * `BULK_CREATED`: A bulk order was created * `BULK_FINISHED`: The processing of a bulk order was completed * `ORDER_CANCELLED`: An order was cancelled * `ORDER_CREATED`: An order was created * `ORDER_FULFILLED`: An order was fulfilled * `ORDER_EDITED`: Parameters of an order were edited * `ORDER_EXPIRED`: An order expired without being fulfilled * `ORDER_EXPIRING_SOON`: An order will expire within the next 72 hours * `ORDER_FAILED`: The fulfillment of an order failed * `ORDER_MONITORING_PARTIAL_FAILED`: Order cannot be fulfilled for some TOIs * `ORDER_REJECTED`: An order was rejected * `ORDER_LOCK_IN_CONFIRMED`: The lock-in of an Assured Tasking order was confirmed * `ORDER_LOCK_IN_FAILED`: The lock-in of an Assured Tasking order failed * `ORDER_LOCK_IN_EXCEPTION`: An internal exception occurred while locking in an Assured Tasking order * `ORDER_LOCK_IN_REJECTED`: The lock-in of an Assured Tasking order was rejected by Planet's scheduling systems * `ORDER_LOCK_IN_FINALIZING`: An Assured Tasking order is being finalized * `ORDER_LOCK_IN_CANCELLATION_FAILED`: The cancellation of an Assured Tasking order did not succeed * `ORDER_LOCK_IN_CANCELLATION_REQUESTED`: The cancellation of an Assured Tasking order was requested * `ORDER_PENDING`: An order is pending and awaiting its start time * `ORDER_STARTED`: The start time of an order was reached and it is now in progress * `CAPTURE_REVIEW_UPDATE`: A capture review was updated * `EXPRESS_ORDER_NO_IMAGING_WINDOW_FOUND`: No imaging window was found for an Express Tasking order (deprecated) * `EXPRESS_ORDER_MAX_ATTEMPTS_REACHED`: The maximum number of attempts to find an imaging window for an Express Tasking order was reached (deprecated) * `EXPRESS_ORDER_IMAGING_WINDOW_CONFIRMATION_TIMEOUT`: The imaging window for an Express Tasking order could not be confirmed in time (deprecated) * `ORDER_WAITLISTED`: An order was created using an unavailable imaging window * `ORDER_WAITLIST_EXPIRED`: A waitlisted order expired before the imaging window became available * `ORDER_WAITLIST_ABANDONED`: The order has left the waitlist * `DELIVERY_TASK_STARTED`: The delivery process has started. * `DELIVERY_TASK_COMPLETED`: The delivery process has been completed. * `DELIVERY_TASK_FAILED`: The delivery process has failed. * `DELIVERY_TASK_CANCELLED`: The delivery process has been cancelled. * `DELIVERY_TASK_EXPIRED`: The delivery has expired. * `CAPTURE_MANUALLY_ASSESSED` - Capture Manually Assessed * `CAPTURE_SCHEDULED` - Capture Scheduled * `CAPTURE_PROCESSING` - Capture Processing * `CAPTURE_PUBLISHED` - Capture Published * `CAPTURE_DERIVING` - Capture Deriving * `CAPTURE_L1A_PUBLISHED` - Capture L1A Published * `CAPTURE_FAILED` - Capture Failed * `CAPTURE_NOT_COVERED` - Capture Not Covered * `BULK_CREATED` - Bulk Created * `BULK_FINISHED` - Bulk Finished * `ORDER_CANCELLED` - Order Cancelled * `ORDER_CREATED` - Order Created * `ORDER_FULFILLED` - Order Fulfilled * `ORDER_EDITED` - Order Edited * `ORDER_EXPIRED` - Order Expired * `ORDER_EXPIRING_SOON` - Order Expiring Soon * `ORDER_FAILED` - Order Failed * `ORDER_MONITORING_PARTIAL_FAILED` - Order Monitoring Partial Failed * `ORDER_REJECTED` - Order Rejected * `ORDER_LOCK_IN_CONFIRMED` - Order Lock-In Confirmed * `ORDER_LOCK_IN_FAILED` - Order Lock-In Failed * `ORDER_LOCK_IN_EXCEPTION` - Order Lock-In Exception * `ORDER_LOCK_IN_REJECTED` - Order Lock-In Rejected * `ORDER_LOCK_IN_FINALIZING` - Order Lock-In Finalizing * `ORDER_LOCK_IN_CANCELLATION_FAILED` - Order Lock-In Cancellation Failed * `ORDER_LOCK_IN_CANCELLATION_REQUESTED` - Order Lock-In Cancellation Requested * `ORDER_PENDING` - Order Pending * `ORDER_STARTED` - Order Started * `ORDER_WAITLISTED` - Order Waitlisted * `ORDER_WAITLIST_EXPIRED` - Order Waitlist Expired * `ORDER_WAITLIST_ABANDONED` - Order Waitlist Abandoned * `EXPRESS_ORDER_NO_IMAGING_WINDOW_FOUND` - Express Order No Imaging Window Found * `EXPRESS_ORDER_MAX_ATTEMPTS_REACHED` - Express Order Max Attempts Reached * `EXPRESS_ORDER_IMAGING_WINDOW_CONFIRMATION_TIMEOUT` - Express Order Imaging Window Confirmation Timeout * `CAPTURE_REVIEW_UPDATE` - Capture Review Update * `DELIVERY_TASK_STARTED` - The delivery process has started. * `DELIVERY_TASK_COMPLETED` - The delivery process has been completed. * `DELIVERY_TASK_FAILED` - The delivery process has failed. * `DELIVERY_TASK_CANCELLED` - The delivery process has been cancelled. * `DELIVERY_TASK_EXPIRED` - The delivery has expired. created_time: type: string format: date-time readOnly: true description: Time the event was created order_id: type: string format: uuid nullable: true description: Unique identifier of the order the event applies to org_id: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true description: Organization ID owning the referenced object required: - created_time - data - event_type - message - target_id - target_type - user_email ImagingWindow: type: object properties: id: type: string format: uuid readOnly: true title: Imaging Window ID description: UUID of the Imaging Window geometry: allOf: - $ref: '#/components/schemas/Geometry' readOnly: true description: >- GeoJSON representation of a Point or a two-point LineString to serve as the area of interest for the imaging window cloud_forecast: type: array items: $ref: '#/components/schemas/CloudForecast' readOnly: true description: >- Predicted cloud cover during the imaging window. The initial forecast is given at the time of the search. If an imaging window is used to submit an order, its forecast will be updated periodically, and the array will contain multiple forecast results in chronological order. product: type: string readOnly: true title: Product name description: Name of the product this imaging window is associated with pl_number: type: string readOnly: true title: Contract number description: Contract number this imaging window is associated with ground_sample_distance_max: type: number format: double readOnly: true title: Maximum ground sample distance description: Maximum permitted ground sample distance (in meters) low_light: type: boolean readOnly: true description: >- Indicates that sun elevation angle min or max of the imaging window is below 10 degrees conflicting_orders: type: array items: $ref: '#/components/schemas/ConflictingOrder' readOnly: true default: [] description: >- Existing tasking orders that conflict with the imaging window. If an imaging window with conflicting orders is used to submit a new order, the existing conflicting orders listed here will be replaced. Imaging windows with conflicting orders will only appear in the results if the `show_replacing_imaging_windows=true` query parameter is passed to retrieve the search results. pricing_details: allOf: - $ref: '#/components/schemas/ImagingWindowPricingDetails' readOnly: true nullable: true description: >- Pricing details of the imaging window. Can be used to preview the cost of using the imaging window to submit an order. only_via_waitlist: type: boolean readOnly: true description: >- Indicates whether the imaging window is available only via waitlisting. If true, using the imaging window to submit an order will cause the order to remain in status `WAITLISTED` until the imaging window becomes available. start_time: type: string format: date-time description: Start time of the imaging window end_time: type: string format: date-time description: End time of the imaging window start_off_nadir: type: number format: double description: Off-nadir angle at the start time of the imaging window end_off_nadir: type: number format: double description: Off-nadir angle at the end time of the imaging window satellite_hw_id: type: string writeOnly: true maxLength: 10 dedicated_satellite_hw_id: type: string nullable: true maxLength: 10 created_time: type: string format: date-time readOnly: true nullable: true description: >- Time the imaging window was created. Imaging windows are valid for 20 minutes after creation. satellite_elevation_angle_min: type: number format: double description: Minimum elevation of the satellite during the imaging window satellite_elevation_angle_max: type: number format: double description: Maximum elevation of the satellite during the imaging window solar_zenith_angle_min: type: number format: double nullable: true title: Minimum solar zenith angle description: Minimum zenith angle of the sun during the imaging window solar_zenith_angle_max: type: number format: double nullable: true title: Maximum solar zenith angle description: Maximum zenith angle of the sun during the imaging window sun_elevation_angle_min: type: number format: double nullable: true title: Minimum sun elevation angle description: Minimum elevation of the sun during the imaging window sun_elevation_angle_max: type: number format: double nullable: true title: Maximum sun elevation angle description: Maximum elevation of the sun during the imaging window sat_azimuth_angle_start: type: number format: double nullable: true title: Satellite azimuth angle at start time description: Satellite azimuth angle at the start time of the imaging window sat_azimuth_angle_end: type: number format: double nullable: true title: Satellite azimuth angle at end time description: Satellite azimuth angle at the end time of the imaging window existing_activities: nullable: true deadline: type: string format: date-time writeOnly: true nullable: true occupancy: enum: - empty - cancelable - aggregatable - unavailable - null type: string description: |- * `empty` - Empty * `cancelable` - Cancelable * `aggregatable` - Aggregatable * `unavailable` - Unavailable x-spec-enum-id: ea2a1d26869ee191 writeOnly: true nullable: true min_off_nadir: type: number format: double description: Minimum off-nadir angle of the satellite during the imaging window max_off_nadir: type: number format: double description: Maximum off-nadir angle of the satellite during the imaging window error_code: type: string nullable: true ground_sample_distance: type: number format: double nullable: true description: >- Estimated ground sample distance at the midpoint of the imaging window (in meters) assured_tasking_tier: enum: - NOT_APPLICABLE - STANDARD - EXPRESS type: string x-spec-enum-id: bdb1bbf393dbb2d1 description: >- Imaging windows occurring within the first six hours from the time of search are considered `EXPRESS` * `NOT_APPLICABLE` - Not Applicable * `STANDARD` - Standard * `EXPRESS` - Express cloud_forecast_initial: type: number format: double nullable: true cloud_forecast_latest: type: number format: double nullable: true cloud_forecast_latest_updated_time: type: string format: date-time nullable: true quota_priority_multiplier: type: number format: double readOnly: true sensitivity_mode: enum: - NOT_APPLICABLE - GLINT - STANDARD - MEDIUM - HIGH - MAX - PUSHBROOM type: string x-spec-enum-id: 164c294ecc3dfe16 description: >- The sensitivity mode influences the number of integrations performed during hyperspectral imagery capture. Possible values are: * `NOT_APPLICABLE`: Not a hyperspectral imagery order * `GLINT`: * `STANDARD: 1 integrations per line over a 8 ms duration (1x8) * `MEDIUM`: 2 integrations per line over a 8 ms duration (2x8) * `HIGH: 3 integrations per line over a 8 ms duration (3x8) * `MAX: 4 integrations per line over a 8 ms duration (4x8) * `NOT_APPLICABLE` - Not Applicable * `GLINT` - Glint * `STANDARD` - Standard * `MEDIUM` - Medium * `HIGH` - High * `MAX` - Max * `PUSHBROOM` - Pushbroom satellite_type: enum: - SKYSAT - PELICAN - TANAGER type: string x-spec-enum-id: a084571859659279 description: |- Satellite type of the imaging window * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager search_request: type: string format: uuid title: Search Request ID description: UUID of the Imaging Window Search Request nullable: true existing_orders: type: array items: $ref: '#/components/schemas/NestedExistingOrder' readOnly: true default: [] unknown_tasks: type: array items: type: string format: uuid readOnly: true reasons_to_discard: type: array items: type: string readOnly: true is_prepaid: type: boolean description: >- Indicates that by using this imaging window, the submitted order won't consume extra quota unavailable_reasons: type: array items: type: string required: - cloud_forecast - conflicting_orders - created_time - end_off_nadir - end_time - existing_orders - geometry - ground_sample_distance_max - id - low_light - max_off_nadir - min_off_nadir - only_via_waitlist - pl_number - pricing_details - product - quota_priority_multiplier - reasons_to_discard - satellite_elevation_angle_max - satellite_elevation_angle_min - satellite_hw_id - start_off_nadir - start_time - unknown_tasks ImagingWindowPricingDetails: type: object properties: units: enum: - SQKM - CREDITS type: string description: |- * `SQKM` - Sqkm * `CREDITS` - Credits x-spec-enum-id: 40530f6084312f5d estimated_quota_cost: type: number format: double determined_by: enum: - pricing_model - replaced_orders - dedicated_capacity type: string description: |- * `pricing_model` - Pricing Model * `replaced_orders` - Replaced Orders * `dedicated_capacity` - Dedicated Capacity x-spec-enum-id: c799a2ec2d23c39d pricing_model: $ref: '#/components/schemas/PricingModel' replaced_orders: type: array items: $ref: '#/components/schemas/ReplacedOrder' nullable: true readOnly: true required: - determined_by - estimated_quota_cost - pricing_model - replaced_orders - units ImagingWindowSearchDetails: type: object properties: id: type: string format: uuid readOnly: true title: Search Request ID description: UUID of the Imaging Window Search Request imaging_windows: type: array items: $ref: '#/components/schemas/ImagingWindowSearchResult' readOnly: true default: [] description: >- Imaging windows matching the search criteria. Will be empty immediately after placing the search. Results will be populated progressively until the status of the search request changes to `DONE`. status: enum: - CREATED - DONE - FAILED type: string x-spec-enum-id: a9bab9f8a839eed4 readOnly: true description: >- Status of the imaging window search request. Possible values are: * `CREATED`: The request was created and is not completed yet. Additional imaging windows may be added. * `DONE`: The request was completed and all matching imaging windows are available. * `FAILED`: A failure occurred during the search. * `CREATED` - Created * `DONE` - Done * `FAILED` - Failed pl_number: type: string title: Contract number description: >- Contract number of the search request. Required if you have access to multiple products or contracts. product: type: string title: Product name description: >- Name of the product of the search request. Required if you have access to multiple products or contracts. geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 description: >- GeoJSON representation of a Point or a two-point LineString to serve as the area of interest for the imaging window search. start_time: type: string format: date-time description: Time from which to consider imaging windows. Defaults to now. end_time: type: string format: date-time description: >- Time until which to consider imaging windows. Defaults to 7 days from now. sat_elevation_angle_min: type: number format: double maximum: 90 minimum: 15 title: Minimum satellite elevation angle description: >- Minimum elevation of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. sat_elevation_angle_max: type: number format: double maximum: 90 minimum: 15 title: Maximum satellite elevation angle description: >- Maximum elevation of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. off_nadir_angle_min: type: number format: double maximum: 65 minimum: 0 title: Minimum off-nadir angle description: >- Minimum off-nadir angle of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. off_nadir_angle_max: type: number format: double maximum: 65 minimum: 0 title: Maximum off-nadir angle description: >- Maximum off-nadir angle of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. sat_azimuth_angle_min: type: number format: double maximum: 360 minimum: -360 title: Minimum satellite azimuth angle description: Minimum satellite azimuth angle during the imaging window. sat_azimuth_angle_max: type: number format: double maximum: 360 minimum: -360 title: Maximum satellite azimuth angle description: Maximum satellite azimuth angle during the imaging window. solar_zenith_angle_min: type: number format: double maximum: 90 minimum: 0 title: Minimum solar zenith angle description: Minimum solar zenith angle during the imaging window. solar_zenith_angle_max: type: number format: double maximum: 90 minimum: 0 title: Maximum solar zenith angle description: Maximum solar zenith angle during the imaging window. solar_azimuth_angle_min: type: number format: double maximum: 360 minimum: -360 title: Minimum solar azimuth angle description: Minimum solar azimuth angle during the imaging window. solar_azimuth_angle_max: type: number format: double maximum: 360 minimum: -360 title: Maximum solar azimuth angle description: Maximum solar azimuth angle during the imaging window. error_code: enum: - INTERNAL_ERROR - TIMEOUT_ERROR - SERVICE_UNAVAILABLE - null type: string x-spec-enum-id: bba3578cd25e5923 readOnly: true nullable: true description: >- Provides additional context if an error occurred during the imaging window search. * `INTERNAL_ERROR` - An error occurred while processing the search request * `TIMEOUT_ERROR` - Timeout while waiting for search request to be completed * `SERVICE_UNAVAILABLE` - Service is unavailable error_message: type: string nullable: true readOnly: true description: >- Provides additional context if an error occurred during the imaging window search. required: - error_code - error_message - geometry - id - imaging_windows - status ImagingWindowSearchRequest: type: object properties: pl_number: type: string title: Contract number description: >- Contract number of the search request. Required if you have access to multiple products or contracts. product: type: string title: Product name description: >- Name of the product of the search request. Required if you have access to multiple products or contracts. geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 description: >- GeoJSON representation of a Point or a two-point LineString to serve as the area of interest for the imaging window search. start_time: type: string format: date-time description: Time from which to consider imaging windows. Defaults to now. end_time: type: string format: date-time description: >- Time until which to consider imaging windows. Defaults to 7 days from now. sat_elevation_angle_min: type: number format: double maximum: 90 minimum: 15 title: Minimum satellite elevation angle description: >- Minimum elevation of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. sat_elevation_angle_max: type: number format: double maximum: 90 minimum: 15 title: Maximum satellite elevation angle description: >- Maximum elevation of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. off_nadir_angle_min: type: number format: double maximum: 65 minimum: 0 title: Minimum off-nadir angle description: >- Minimum off-nadir angle of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. off_nadir_angle_max: type: number format: double maximum: 65 minimum: 0 title: Maximum off-nadir angle description: >- Maximum off-nadir angle of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. sat_azimuth_angle_min: type: number format: double maximum: 360 minimum: -360 title: Minimum satellite azimuth angle description: Minimum satellite azimuth angle during the imaging window. sat_azimuth_angle_max: type: number format: double maximum: 360 minimum: -360 title: Maximum satellite azimuth angle description: Maximum satellite azimuth angle during the imaging window. solar_zenith_angle_min: type: number format: double maximum: 90 minimum: 0 title: Minimum solar zenith angle description: Minimum solar zenith angle during the imaging window. solar_zenith_angle_max: type: number format: double maximum: 90 minimum: 0 title: Maximum solar zenith angle description: Maximum solar zenith angle during the imaging window. solar_azimuth_angle_min: type: number format: double maximum: 360 minimum: -360 title: Minimum solar azimuth angle description: Minimum solar azimuth angle during the imaging window. solar_azimuth_angle_max: type: number format: double maximum: 360 minimum: -360 title: Maximum solar azimuth angle description: Maximum solar azimuth angle during the imaging window. satellite_types: type: array items: enum: - SKYSAT - PELICAN - TANAGER type: string description: |- * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager x-spec-enum-id: a084571859659279 description: Satellite types to search for imaging windows for. minItems: 1 sensitivity_mode: enum: - NOT_APPLICABLE - GLINT - STANDARD - MEDIUM - HIGH - MAX - PUSHBROOM type: string x-spec-enum-id: 164c294ecc3dfe16 description: >- The sensitivity mode influences the number of integrations performed during hyperspectral imagery capture. Possible values are: * `NOT_APPLICABLE`: Not a hyperspectral imagery order * `GLINT`: * `STANDARD: 1 integrations per line over a 8 ms duration (1x8) * `MEDIUM`: 2 integrations per line over a 8 ms duration (2x8) * `HIGH: 3 integrations per line over a 8 ms duration (3x8) * `MAX: 4 integrations per line over a 8 ms duration (4x8) * `NOT_APPLICABLE` - Not Applicable * `GLINT` - Glint * `STANDARD` - Standard * `MEDIUM` - Medium * `HIGH` - High * `MAX` - Max * `PUSHBROOM` - Pushbroom required: - geometry ImagingWindowSearchResult: type: object properties: id: type: string format: uuid readOnly: true title: Imaging Window ID description: UUID of the Imaging Window satellite_type: enum: - SKYSAT - PELICAN - TANAGER type: string x-spec-enum-id: a084571859659279 description: |- Satellite type of the imaging window * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager start_time: type: string format: date-time readOnly: true description: Start time of the imaging window end_time: type: string format: date-time readOnly: true description: End time of the imaging window off_nadir_angle_start: type: number format: double maximum: 65 minimum: 0 description: Off-nadir angle at the end time of the imaging window off_nadir_angle_end: type: number format: double maximum: 65 minimum: 0 description: Off-nadir angle at the start time of the imaging window off_nadir_angle_min: type: number format: double maximum: 65 minimum: 0 title: Minimum off-nadir angle description: Minimum off-nadir angle of the satellite during the imaging window off_nadir_angle_max: type: number format: double maximum: 65 minimum: 0 title: Maximum off-nadir angle description: Maximum off-nadir angle of the satellite during the imaging window sat_elevation_angle_min: type: number format: double maximum: 90 minimum: 15 title: Minimum satellite elevation angle description: Minimum elevation of the satellite during the imaging window sat_elevation_angle_max: type: number format: double maximum: 90 minimum: 15 title: Maximum satellite elevation angle description: Maximum elevation of the satellite during the imaging window sat_azimuth_angle_start: type: number format: double readOnly: true nullable: true title: Satellite azimuth angle at start time description: Satellite azimuth angle at the start time of the imaging window sat_azimuth_angle_end: type: number format: double readOnly: true nullable: true title: Satellite azimuth angle at end time description: Satellite azimuth angle at the end time of the imaging window sun_elevation_angle_min: type: number format: double readOnly: true nullable: true title: Minimum sun elevation angle description: Minimum elevation of the sun during the imaging window sun_elevation_angle_max: type: number format: double readOnly: true nullable: true title: Maximum sun elevation angle description: Maximum elevation of the sun during the imaging window solar_zenith_angle_min: type: number format: double readOnly: true nullable: true title: Minimum solar zenith angle description: Minimum zenith angle of the sun during the imaging window solar_zenith_angle_max: type: number format: double readOnly: true nullable: true title: Maximum solar zenith angle description: Maximum zenith angle of the sun during the imaging window low_light: type: boolean readOnly: true description: >- Indicates that sun elevation angle min or max of the imaging window is below 10 degrees ground_sample_distance: type: number format: double description: >- Estimated ground sample distance at the midpoint of the imaging window (in meters) assured_tasking_tier: enum: - STANDARD - EXPRESS type: string x-spec-enum-id: 0f91c35537905245 description: >- Imaging windows occurring within the first six hours from the time of search are considered `EXPRESS` * `STANDARD` - STANDARD * `EXPRESS` - EXPRESS cloud_forecast: type: array items: $ref: '#/components/schemas/SimpleCloudForecast' readOnly: true description: >- Predicted cloud cover during the imaging window. The initial forecast is given at the time of the search. If an imaging window is used to submit an order, its forecast will be updated periodically, and the array will contain multiple forecast results in chronological order. conflicting_orders: type: array items: $ref: '#/components/schemas/NestedConflictingOrder' readOnly: true default: [] description: >- Existing tasking orders that conflict with the imaging window. If an imaging window with conflicting orders is used to submit a new order, the existing conflicting orders listed here will be replaced. Imaging windows with conflicting orders will only appear in the results if the `show_replacing_imaging_windows=true` query parameter is passed to retrieve the search results. pricing_details: allOf: - $ref: '#/components/schemas/ImagingWindowPricingDetails' readOnly: true nullable: true description: >- Pricing details of the imaging window. Can be used to preview the cost of using the imaging window to submit an order. sensitivity_mode: enum: - NOT_APPLICABLE - GLINT - STANDARD - MEDIUM - HIGH - MAX - PUSHBROOM type: string x-spec-enum-id: 164c294ecc3dfe16 readOnly: true description: >- The sensitivity mode influences the number of integrations performed during hyperspectral imagery capture. Possible values are: * `NOT_APPLICABLE`: Not a hyperspectral imagery order * `GLINT`: * `STANDARD: 1 integrations per line over a 8 ms duration (1x8) * `MEDIUM`: 2 integrations per line over a 8 ms duration (2x8) * `HIGH: 3 integrations per line over a 8 ms duration (3x8) * `MAX: 4 integrations per line over a 8 ms duration (4x8) * `NOT_APPLICABLE` - Not Applicable * `GLINT` - Glint * `STANDARD` - Standard * `MEDIUM` - Medium * `HIGH` - High * `MAX` - Max * `PUSHBROOM` - Pushbroom only_via_waitlist: type: boolean readOnly: true description: >- Indicates whether the imaging window is available only via waitlisting. If true, using the imaging window to submit an order will cause the order to remain in status `WAITLISTED` until the imaging window becomes available. required: - cloud_forecast - conflicting_orders - end_time - id - low_light - only_via_waitlist - pricing_details - sat_azimuth_angle_end - sat_azimuth_angle_start - sensitivity_mode - solar_zenith_angle_max - solar_zenith_angle_min - start_time - sun_elevation_angle_max - sun_elevation_angle_min LocationResponse: type: object properties: location: type: string format: uri required: - location NestedConflictingOrder: type: object properties: id: type: string format: uuid readOnly: true title: Order ID description: Unique identifier of an order name: type: string readOnly: true description: User-defined name of an order off_nadir_angle_min: type: number format: double nullable: true title: Minimum off-nadir angle description: >- Minimum off-nadir angle of the satellite to acquire imagery for the order off_nadir_angle_max: type: number format: double nullable: true title: Maximum off-nadir angle description: >- Maximum off-nadir angle of the satellite to acquire imagery for the order sat_elevation_angle_min: type: number format: double nullable: true title: Minimum satellite elevation angle description: Minimum elevation of the satellite to acquire imagery for the order sat_elevation_angle_max: type: number format: double nullable: true title: Maximum satellite elevation angle description: Maximum elevation of the satellite to acquire imagery for the order cloud_forecast: type: array items: $ref: '#/components/schemas/SimpleCloudForecast' readOnly: true nullable: true description: >- Predicted cloud cover for the order. The forecast will be updated periodically, and the array will contain multiple forecast results in chronological order. Only available for Assured Tasking orders. assured_tasking_tier: enum: - NOT_APPLICABLE - STANDARD - EXPRESS type: string x-spec-enum-id: bdb1bbf393dbb2d1 readOnly: true description: |- Tier as determined by the imaging window of an Assured Tasking order * `NOT_APPLICABLE` - Not Applicable * `STANDARD` - Standard * `EXPRESS` - Express required: - assured_tasking_tier - cloud_forecast - id - name NestedExistingOrder: type: object properties: id: type: string format: uuid readOnly: true title: Order ID description: Unique identifier of an order pl_number: type: string readOnly: true title: Contract number description: >- Contract number of the order. Required if you have access to multiple products or contracts. customer_org_id: type: integer readOnly: true description: Organization ID of the contract holder who owns the order scheduling_type: enum: - FLEXIBLE - LOCK_IN - MONITORING - EXPRESS - ASSURED - ARCHIVE type: string x-spec-enum-id: 3d5d72179084691b readOnly: true description: >- The way the order will be scheduled for capturing imagery. Must match the product. * `FLEXIBLE` - Flexible * `LOCK_IN` - Lock-In * `MONITORING` - Monitoring * `EXPRESS` - Express * `ASSURED` - Assured * `ARCHIVE` - Archive assured_tasking_tier: enum: - NOT_APPLICABLE - STANDARD - EXPRESS type: string x-spec-enum-id: bdb1bbf393dbb2d1 readOnly: true description: |- Tier as determined by the imaging window of an Assured Tasking order * `NOT_APPLICABLE` - Not Applicable * `STANDARD` - Standard * `EXPRESS` - Express required: - assured_tasking_tier - customer_org_id - id - pl_number - scheduling_type Order: type: object properties: id: type: string format: uuid readOnly: true title: Order ID description: Unique identifier of an order imaging_window: type: string format: uuid title: Imaging Window ID description: >- Imaging window ID to create an order for. Required to place an Assured Tasking order. Cannot be used for other scheduling types. nullable: true geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 description: >- GeoJSON representation of a Point, a two-point LineString or a Polygon. A polygon can contain at most 1500 vertices. Point and LineString inputs will be expanded into a circular or rectangle Polygon respectively to serve as the area of interest for this order. The expansion size defaults to 5 km for SkySat imagery but can vary based on product parameters. Required for all orders except Assured Tasking orders. original_geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 nullable: true description: >- GeoJSON representation of the original `geometry` submitted when the order was created fulfilled_geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 readOnly: true nullable: true description: >- GeoJSON representation of the order's geometry, intersected with the combination of the geometries from its fulfilling captures capture_count: type: integer maximum: 2147483647 minimum: 0 description: Number of captures to be taken to fulfill the order capture_status_queued_count: type: integer maximum: 2147483647 minimum: 0 title: Number of queued captures description: >- Number of captures currently scheduled for acquisition on a satellite capture_status_processing_count: type: integer maximum: 2147483647 minimum: 0 title: Number of processing captures description: >- Number of captures currently being processed by Planet's image processing pipeline capture_status_failed_count: type: integer maximum: 2147483647 minimum: 0 readOnly: true title: Number of failed captures description: Number of captures that failed to be processed successfully capture_status_published_count: type: integer maximum: 2147483647 minimum: 0 readOnly: true title: Number of published captures description: Number of captures that have been published for this order capture_assessment_success_count: type: integer maximum: 2147483647 minimum: 0 readOnly: true title: Number of captures assessed successful description: >- Number of captures that were assessed as successful based on image quality capture_assessment_invalid_count: type: integer maximum: 2147483647 minimum: 0 readOnly: true title: Number of captures assessed invalid description: >- Number of captures that were assessed as invalid based on image quality order_type: enum: - IMAGE - STEREO type: string x-spec-enum-id: 90674fb98c2d24cf description: >- Type of imagery to be acquired for this order. Possible values are: * `IMAGE`: A regular capture with a single point of view onto the area of interest * `STEREO`: A stereographic capture that consists of 2 or 3 points of view (depending on `n_stereo_pov`) * `IMAGE` - Image * `STEREO` - Stereo fulfilled_time: type: string format: date-time nullable: true description: Time the order was fulfilled pl_number: type: string nullable: true title: Contract number description: >- Contract number of the order. Required if you have access to multiple products or contracts. product: type: string nullable: true title: Product name description: >- Name of the product of the order. Required if you have access to multiple products or contracts. sat_elevation_angle_min: type: number format: double maximum: 90 minimum: 15 title: Minimum satellite elevation angle description: Minimum elevation of the satellite to acquire imagery for the order sat_elevation_angle_max: type: number format: double maximum: 90 minimum: 15 title: Maximum satellite elevation angle description: Maximum elevation of the satellite to acquire imagery for the order start_time: type: string format: date-time description: >- Time at which to start acquiring imagery for the order. Defaults to the time of order submission. end_time: type: string format: date-time nullable: true description: >- Latest time by which imagery will be acquired for the order. Defaults to the contract's default order duration (from the time of order submission). early_start: type: boolean nullable: true description: >- Whether a Monitoring Tasking order should begin immediately. This causes the first occurrence to have a shorter time of interest. Cannot be used for other scheduling types. cloud_threshold: type: number format: double maximum: 1 minimum: 0 description: Cloud coverage threshold for an order to be scheduled for imaging satellite_types: type: array items: enum: - SKYSAT - PELICAN - TANAGER type: string description: |- * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager x-spec-enum-id: a084571859659279 description: Satellite types to acquire the imagery for the order minItems: 1 data_products: type: array items: enum: - HIGH_RESOLUTION_SCENES - HYPERSPECTRAL_SCENES - TANAGER_METHANE_DETECTION type: string description: |- * `HIGH_RESOLUTION_SCENES` - High Resolution Scenes * `HYPERSPECTRAL_SCENES` - Hyperspectral Scenes * `TANAGER_METHANE_DETECTION` - Tanager Methane Detection x-spec-enum-id: 7bb913a518381932 readOnly: true description: Data products requested to be generated for the order n_stereo_pov: enum: - 2 - 3 - null type: integer x-spec-enum-id: 6f8bdde0f4f15994 nullable: true title: Number of stereo captures description: >- Number of captures to be taken for Stereo Tasking orders. The convergence half angle is 15° for 2 stereo captures, and 27.5° for 3 stereo captures. * `2` - 2 * `3` - 3 is_cancellable: type: boolean readOnly: true title: Can be cancelled description: >- Whether the order is cancellable. Cancellation may be prohibited by certain conditions under your contract's Terms of Service, for example if an order is already in status `IN_PROGRESS`. cancellable_until: type: string format: date-time readOnly: true description: >- Time until which this order can be cancelled. Cancellation may be prohibited by certain conditions under your contract's Terms of Service, for example if an order is already in status `IN_PROGRESS` or its `cancellation_period` has been reached. requested_sqkm: type: number format: double minimum: 0 readOnly: true title: Requested square kilometers description: Requested surface area of the order (in square kilometers) fulfilled_sqkm: type: number format: double minimum: 0 readOnly: true title: Fulfilled square kilometers description: Fulfilled surface area of the order (in square kilometers) next_planned_acquisition_time: type: string format: date-time nullable: true readOnly: true description: Time for which the next imagery acquisition of an order is scheduled exclusivity_days: enum: - 0 - 7 - 30 - null type: integer x-spec-enum-id: f91f89160ed49e03 nullable: true description: >- Number of days for the captured imagery to be held exclusive for this order * `0` - 0 * `7` - 7 * `30` - 30 created_by: type: string readOnly: true description: User who created the order requested_item_ids: type: array items: type: string description: >- Requested item IDs for Archive Tasking orders. Cannot be used for other scheduling types. created_time: type: string format: date-time readOnly: true nullable: true description: Time of order creation updated_time: type: string format: date-time readOnly: true nullable: true description: Time the order was last updated name: type: string description: User-defined name of an order status: enum: - RECEIVED - PENDING - IN_PROGRESS - EXPIRED - FULFILLED - FAILED - CANCELLED - REQUESTED - FINALIZING - PENDING_CANCELLATION - REJECTED - WAITLISTED - WAITLIST_ABANDONED - WAITLIST_EXPIRED type: string x-spec-enum-id: ce5b6ce9e674887f readOnly: true description: >- Current status of the order. Possible values are: * `RECEIVED`/`PENDING`/`REQUESTED`: The order was received and is awaiting its start time * `IN_PROGRESS`: The order has reached its start time and will be scheduled for imaging * `FINALIZING`: Imagery has been downlinked and is being processed for publication * `FULFILLED`: The order has been fulfilled and a successful capture is available * `EXPIRED`: The order has reached is end time without a successful capture and is now expired. * `REJECTED`: The order has been rejected by Planet's systems because it cannot be scheduled properly * `FAILED`: An internal error occurred while fulfilling the order * `PENDING_CANCELLATION`: The cancellation of the order was requested and is yet to be confirmed * `CANCELLED`: The order has been cancelled manually * `RECEIVED` - Received * `PENDING` - Pending * `IN_PROGRESS` - In Progress * `EXPIRED` - Expired * `FULFILLED` - Fulfilled * `FAILED` - Failed * `CANCELLED` - Cancelled * `REQUESTED` - Requested * `FINALIZING` - Finalizing * `PENDING_CANCELLATION` - Pending Cancellation * `REJECTED` - Rejected * `WAITLISTED` - Waitlisted * `WAITLIST_ABANDONED` - Waitlist Abandoned * `WAITLIST_EXPIRED` - Waitlist Expired original_geometry_type: enum: - Point - LineString - Polygon type: string x-spec-enum-id: 75d1d07b2919db2e readOnly: true description: |- Type of the original geometry submitted when the order was created * `Point` - Point * `LineString` - LineString * `Polygon` - Polygon capture_status_deriving_count: type: integer maximum: 2147483647 minimum: 0 description: >- Number of captures that have been published, but some requested assets are still being processed scheduling_type: enum: - FLEXIBLE - LOCK_IN - MONITORING - EXPRESS - ASSURED - ARCHIVE type: string x-spec-enum-id: 3d5d72179084691b description: >- The way the order will be scheduled for capturing imagery. Must match the product. * `FLEXIBLE` - Flexible * `LOCK_IN` - Lock-In * `MONITORING` - Monitoring * `EXPRESS` - Express * `ASSURED` - Assured * `ARCHIVE` - Archive rrule: type: string nullable: true title: Frequency description: >- Rrule used to schedule individual captures of the order. Only available for Monitoring Tasking orders. cancellation_period: type: string format: duration readOnly: true description: >- Period before the start time of an order, in which it cannot be cancelled any longer cancellation_fee_applied: type: boolean readOnly: true description: Whether a cancellation fee was applied to the order created_as_waitlisted: type: boolean readOnly: true description: Whether the order was initially created as waitlisted last_acquired_time: type: string format: date-time readOnly: true nullable: true description: Time at which the most recent capture was acquired for an order estimated_quota_cost: type: number format: double readOnly: true nullable: true description: Estimated quota cost that will be used to fulfill this order used_quota: type: number format: double readOnly: true description: >- Amount of quota used to fulfill this order. The value may change if the order is not yet fulfilled. min_strip_length: type: number format: double readOnly: true nullable: true description: Minimum length of the imagery strip required to fulfill the order max_strip_length: type: number format: double readOnly: true nullable: true description: Maximum length of the imagery strip required to fulfill the order point_order_radius: type: number format: double readOnly: true nullable: true description: Radius of expansion for orders using a Point geometry (in meters). asset_types: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: |- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Derived asset types to be generated for the order sensitivity_mode: enum: - NOT_APPLICABLE - GLINT - STANDARD - MEDIUM - HIGH - MAX - PUSHBROOM type: string x-spec-enum-id: 164c294ecc3dfe16 description: >- The sensitivity mode influences the number of integrations performed during hyperspectral imagery capture. Possible values are: * `NOT_APPLICABLE`: Not a hyperspectral imagery order * `GLINT`: * `STANDARD: 1 integrations per line over a 8 ms duration (1x8) * `MEDIUM`: 2 integrations per line over a 8 ms duration (2x8) * `HIGH: 3 integrations per line over a 8 ms duration (3x8) * `MAX: 4 integrations per line over a 8 ms duration (4x8) * `NOT_APPLICABLE` - Not Applicable * `GLINT` - Glint * `STANDARD` - Standard * `MEDIUM` - Medium * `HIGH` - High * `MAX` - Max * `PUSHBROOM` - Pushbroom integrations_per_line: type: integer maximum: 32767 minimum: 0 nullable: true description: >- Number of integrations per line should be performed via the sensitivity mode. This is an internal numerical interpretation of that mode. integration_ms: type: integer maximum: 32767 minimum: 0 nullable: true description: >- Duration of a single integration during a hyperspectral imagery capture (in milliseconds). This is an experimental setting, and not widely available. uplink_method: enum: - STANDARD - RTCOMMS type: string x-spec-enum-id: b79aa7aeab4396fd description: |- Method used to uplink scheduling information to the satellite * `STANDARD` - Standard * `RTCOMMS` - RT Comms downlink_method: enum: - STANDARD - RTCOMMS type: string x-spec-enum-id: b79aa7aeab4396fd description: |- Method used to downlink imagery from the satellite * `STANDARD` - Standard * `RTCOMMS` - RT Comms required: - cancellable_until - cancellation_fee_applied - cancellation_period - capture_assessment_invalid_count - capture_assessment_success_count - capture_status_failed_count - capture_status_published_count - created_as_waitlisted - created_by - created_time - data_products - estimated_quota_cost - fulfilled_geometry - fulfilled_sqkm - id - is_cancellable - last_acquired_time - max_strip_length - min_strip_length - name - next_planned_acquisition_time - original_geometry_type - point_order_radius - requested_sqkm - status - updated_time - used_quota OrderDetail: type: object properties: id: type: string format: uuid readOnly: true title: Order ID description: Unique identifier of an order imaging_window: type: string format: uuid title: Imaging Window ID description: >- Imaging window ID to create an order for. Required to place an Assured Tasking order. Cannot be used for other scheduling types. nullable: true geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 description: >- GeoJSON representation of a Point, a two-point LineString or a Polygon. A polygon can contain at most 1500 vertices. Point and LineString inputs will be expanded into a circular or rectangle Polygon respectively to serve as the area of interest for this order. The expansion size defaults to 5 km for SkySat imagery but can vary based on product parameters. Required for all orders except Assured Tasking orders. original_geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 nullable: true description: >- GeoJSON representation of the original `geometry` submitted when the order was created fulfilled_geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 readOnly: true nullable: true description: >- GeoJSON representation of the order's geometry, intersected with the combination of the geometries from its fulfilling captures capture_count: type: integer maximum: 2147483647 minimum: 0 description: Number of captures to be taken to fulfill the order capture_status_queued_count: type: integer maximum: 2147483647 minimum: 0 title: Number of queued captures description: >- Number of captures currently scheduled for acquisition on a satellite capture_status_processing_count: type: integer maximum: 2147483647 minimum: 0 title: Number of processing captures description: >- Number of captures currently being processed by Planet's image processing pipeline capture_status_failed_count: type: integer maximum: 2147483647 minimum: 0 readOnly: true title: Number of failed captures description: Number of captures that failed to be processed successfully capture_status_published_count: type: integer maximum: 2147483647 minimum: 0 readOnly: true title: Number of published captures description: Number of captures that have been published for this order capture_assessment_success_count: type: integer maximum: 2147483647 minimum: 0 readOnly: true title: Number of captures assessed successful description: >- Number of captures that were assessed as successful based on image quality capture_assessment_invalid_count: type: integer maximum: 2147483647 minimum: 0 readOnly: true title: Number of captures assessed invalid description: >- Number of captures that were assessed as invalid based on image quality order_type: enum: - IMAGE - STEREO type: string x-spec-enum-id: 90674fb98c2d24cf description: >- Type of imagery to be acquired for this order. Possible values are: * `IMAGE`: A regular capture with a single point of view onto the area of interest * `STEREO`: A stereographic capture that consists of 2 or 3 points of view (depending on `n_stereo_pov`) * `IMAGE` - Image * `STEREO` - Stereo fulfilled_time: type: string format: date-time nullable: true description: Time the order was fulfilled pl_number: type: string nullable: true title: Contract number description: >- Contract number of the order. Required if you have access to multiple products or contracts. product: type: string nullable: true title: Product name description: >- Name of the product of the order. Required if you have access to multiple products or contracts. sat_elevation_angle_min: type: number format: double maximum: 90 minimum: 15 title: Minimum satellite elevation angle description: Minimum elevation of the satellite to acquire imagery for the order sat_elevation_angle_max: type: number format: double maximum: 90 minimum: 15 title: Maximum satellite elevation angle description: Maximum elevation of the satellite to acquire imagery for the order start_time: type: string format: date-time description: >- Time at which to start acquiring imagery for the order. Defaults to the time of order submission. end_time: type: string format: date-time nullable: true description: >- Latest time by which imagery will be acquired for the order. Defaults to the contract's default order duration (from the time of order submission). early_start: type: boolean nullable: true description: >- Whether a Monitoring Tasking order should begin immediately. This causes the first occurrence to have a shorter time of interest. Cannot be used for other scheduling types. cloud_threshold: type: number format: double maximum: 1 minimum: 0 description: Cloud coverage threshold for an order to be scheduled for imaging satellite_types: type: array items: enum: - SKYSAT - PELICAN - TANAGER type: string description: |- * `SKYSAT` - SkySat * `PELICAN` - Pelican * `TANAGER` - Tanager x-spec-enum-id: a084571859659279 description: Satellite types to acquire the imagery for the order minItems: 1 data_products: type: array items: enum: - HIGH_RESOLUTION_SCENES - HYPERSPECTRAL_SCENES - TANAGER_METHANE_DETECTION type: string description: |- * `HIGH_RESOLUTION_SCENES` - High Resolution Scenes * `HYPERSPECTRAL_SCENES` - Hyperspectral Scenes * `TANAGER_METHANE_DETECTION` - Tanager Methane Detection x-spec-enum-id: 7bb913a518381932 readOnly: true description: Data products requested to be generated for the order n_stereo_pov: enum: - 2 - 3 - null type: integer x-spec-enum-id: 6f8bdde0f4f15994 nullable: true title: Number of stereo captures description: >- Number of captures to be taken for Stereo Tasking orders. The convergence half angle is 15° for 2 stereo captures, and 27.5° for 3 stereo captures. * `2` - 2 * `3` - 3 is_cancellable: type: boolean readOnly: true title: Can be cancelled description: >- Whether the order is cancellable. Cancellation may be prohibited by certain conditions under your contract's Terms of Service, for example if an order is already in status `IN_PROGRESS`. cancellable_until: type: string format: date-time readOnly: true description: >- Time until which this order can be cancelled. Cancellation may be prohibited by certain conditions under your contract's Terms of Service, for example if an order is already in status `IN_PROGRESS` or its `cancellation_period` has been reached. requested_sqkm: type: number format: double minimum: 0 readOnly: true title: Requested square kilometers description: Requested surface area of the order (in square kilometers) fulfilled_sqkm: type: number format: double minimum: 0 readOnly: true title: Fulfilled square kilometers description: Fulfilled surface area of the order (in square kilometers) next_planned_acquisition_time: type: string format: date-time nullable: true readOnly: true description: Time for which the next imagery acquisition of an order is scheduled exclusivity_days: enum: - 0 - 7 - 30 - null type: integer x-spec-enum-id: f91f89160ed49e03 nullable: true description: >- Number of days for the captured imagery to be held exclusive for this order * `0` - 0 * `7` - 7 * `30` - 30 created_by: type: string readOnly: true description: User who created the order requested_item_ids: type: array items: type: string description: >- Requested item IDs for Archive Tasking orders. Cannot be used for other scheduling types. created_time: type: string format: date-time readOnly: true nullable: true description: Time of order creation updated_time: type: string format: date-time readOnly: true nullable: true description: Time the order was last updated name: type: string description: User-defined name of an order status: enum: - RECEIVED - PENDING - IN_PROGRESS - EXPIRED - FULFILLED - FAILED - CANCELLED - REQUESTED - FINALIZING - PENDING_CANCELLATION - REJECTED - WAITLISTED - WAITLIST_ABANDONED - WAITLIST_EXPIRED type: string x-spec-enum-id: ce5b6ce9e674887f readOnly: true description: >- Current status of the order. Possible values are: * `RECEIVED`/`PENDING`/`REQUESTED`: The order was received and is awaiting its start time * `IN_PROGRESS`: The order has reached its start time and will be scheduled for imaging * `FINALIZING`: Imagery has been downlinked and is being processed for publication * `FULFILLED`: The order has been fulfilled and a successful capture is available * `EXPIRED`: The order has reached is end time without a successful capture and is now expired. * `REJECTED`: The order has been rejected by Planet's systems because it cannot be scheduled properly * `FAILED`: An internal error occurred while fulfilling the order * `PENDING_CANCELLATION`: The cancellation of the order was requested and is yet to be confirmed * `CANCELLED`: The order has been cancelled manually * `RECEIVED` - Received * `PENDING` - Pending * `IN_PROGRESS` - In Progress * `EXPIRED` - Expired * `FULFILLED` - Fulfilled * `FAILED` - Failed * `CANCELLED` - Cancelled * `REQUESTED` - Requested * `FINALIZING` - Finalizing * `PENDING_CANCELLATION` - Pending Cancellation * `REJECTED` - Rejected * `WAITLISTED` - Waitlisted * `WAITLIST_ABANDONED` - Waitlist Abandoned * `WAITLIST_EXPIRED` - Waitlist Expired original_geometry_type: enum: - Point - LineString - Polygon type: string x-spec-enum-id: 75d1d07b2919db2e readOnly: true description: |- Type of the original geometry submitted when the order was created * `Point` - Point * `LineString` - LineString * `Polygon` - Polygon capture_status_deriving_count: type: integer maximum: 2147483647 minimum: 0 description: >- Number of captures that have been published, but some requested assets are still being processed scheduling_type: enum: - FLEXIBLE - LOCK_IN - MONITORING - EXPRESS - ASSURED - ARCHIVE type: string x-spec-enum-id: 3d5d72179084691b description: >- The way the order will be scheduled for capturing imagery. Must match the product. * `FLEXIBLE` - Flexible * `LOCK_IN` - Lock-In * `MONITORING` - Monitoring * `EXPRESS` - Express * `ASSURED` - Assured * `ARCHIVE` - Archive rrule: type: string nullable: true title: Frequency description: >- Rrule used to schedule individual captures of the order. Only available for Monitoring Tasking orders. cancellation_period: type: string format: duration readOnly: true description: >- Period before the start time of an order, in which it cannot be cancelled any longer cancellation_fee_applied: type: boolean readOnly: true description: Whether a cancellation fee was applied to the order created_as_waitlisted: type: boolean readOnly: true description: Whether the order was initially created as waitlisted last_acquired_time: type: string format: date-time readOnly: true nullable: true description: Time at which the most recent capture was acquired for an order estimated_quota_cost: type: number format: double readOnly: true nullable: true description: Estimated quota cost that will be used to fulfill this order used_quota: type: number format: double readOnly: true description: >- Amount of quota used to fulfill this order. The value may change if the order is not yet fulfilled. min_strip_length: type: number format: double readOnly: true nullable: true description: Minimum length of the imagery strip required to fulfill the order max_strip_length: type: number format: double readOnly: true nullable: true description: Maximum length of the imagery strip required to fulfill the order point_order_radius: type: number format: double readOnly: true nullable: true description: Radius of expansion for orders using a Point geometry (in meters). asset_types: type: array items: enum: - ortho_visual - basic_analytic - basic_analytic_udm2 - basic_analytic_rpc - basic_panchromatic - basic_panchromatic_rpc - basic_panchromatic_udm2 - ortho_analytic - ortho_analytic_sr - ortho_analytic_udm2 - ortho_panchromatic - ortho_pansharpened - ortho_pansharpened_udm2 - basic_radiance_hdf5 - ortho_radiance_hdf5 - ortho_beta_udm - basic_sr_hdf5 - ortho_sr_hdf5 - ortho_ql_ch4 - ql_ch4_json - basic_beta_udm - geolocation_array - recent_monthly_mosaic - ortho_qc_ch4 - qc_ch4_json - basic_l1a_panchromatic - basic_l1a_panchromatic_rpc - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_udm - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_panchromatic_dn - basic_panchromatic_dn_rpc - ortho_analytic_dn - ortho_analytic_udm - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened_udm type: string description: |- * `ortho_visual` - Ortho Visual * `basic_analytic` - Basic Analytic * `basic_analytic_udm2` - Basic Analytic UDM2 * `basic_analytic_rpc` - Basic Analytic RPC * `basic_panchromatic` - Basic Panchromatic * `basic_panchromatic_rpc` - Basic Panchromatic RPC * `basic_panchromatic_udm2` - Basic Panchromatic UDM2 * `ortho_analytic` - Ortho Analytic * `ortho_analytic_sr` - Ortho Analytic SR * `ortho_analytic_udm2` - Ortho Analytic UDM2 * `ortho_panchromatic` - Ortho Panchromatic * `ortho_pansharpened` - Ortho Pansharpened * `ortho_pansharpened_udm2` - Ortho Pansharpened UDM2 * `basic_radiance_hdf5` - Basic Radiance HDF5 * `ortho_radiance_hdf5` - Ortho Radiance HDF5 * `ortho_beta_udm` - Ortho Beta UDM * `basic_sr_hdf5` - Basic SR HDF5 * `ortho_sr_hdf5` - Ortho SR HDF5 * `ortho_ql_ch4` - Ortho QL CH4 * `ql_ch4_json` - QL CH4 JSON * `basic_beta_udm` - Basic Beta UDM * `geolocation_array` - Geolocation Array * `recent_monthly_mosaic` - Recent Monthly Mosaic * `ortho_qc_ch4` - Ortho QC CH4 * `qc_ch4_json` - QC CH4 JSON * `basic_l1a_panchromatic` - Basic L1A Panchromatic * `basic_l1a_panchromatic_rpc` - Basic L1A Panchromatic RPC * `basic_analytic_dn` - Basic Analytic DN * `basic_analytic_dn_rpc` - Basic Analytic DN RPC * `basic_analytic_udm` - Basic Analytic UDM * `basic_l1a_panchromatic_dn` - Basic L1A Panchromatic DN * `basic_l1a_panchromatic_dn_rpc` - Basic L1A Panchromatic DN RPC * `basic_panchromatic_dn` - Basic Panchromatic DN * `basic_panchromatic_dn_rpc` - Basic Panchromatic DN RPC * `ortho_analytic_dn` - Ortho Analytic DN * `ortho_analytic_udm` - Ortho Analytic UDM * `ortho_panchromatic_dn` - Ortho Panchromatic DN * `ortho_panchromatic_udm` - Ortho Panchromatic UDM * `ortho_panchromatic_udm2` - Ortho Panchromatic UDM2 * `ortho_pansharpened_udm` - Ortho Pansharpened UDM x-spec-enum-id: 4923f37c1737fc3c description: Derived asset types to be generated for the order sensitivity_mode: enum: - NOT_APPLICABLE - GLINT - STANDARD - MEDIUM - HIGH - MAX - PUSHBROOM type: string x-spec-enum-id: 164c294ecc3dfe16 description: >- The sensitivity mode influences the number of integrations performed during hyperspectral imagery capture. Possible values are: * `NOT_APPLICABLE`: Not a hyperspectral imagery order * `GLINT`: * `STANDARD: 1 integrations per line over a 8 ms duration (1x8) * `MEDIUM`: 2 integrations per line over a 8 ms duration (2x8) * `HIGH: 3 integrations per line over a 8 ms duration (3x8) * `MAX: 4 integrations per line over a 8 ms duration (4x8) * `NOT_APPLICABLE` - Not Applicable * `GLINT` - Glint * `STANDARD` - Standard * `MEDIUM` - Medium * `HIGH` - High * `MAX` - Max * `PUSHBROOM` - Pushbroom integrations_per_line: type: integer maximum: 32767 minimum: 0 nullable: true description: >- Number of integrations per line should be performed via the sensitivity mode. This is an internal numerical interpretation of that mode. integration_ms: type: integer maximum: 32767 minimum: 0 nullable: true description: >- Duration of a single integration during a hyperspectral imagery capture (in milliseconds). This is an experimental setting, and not widely available. uplink_method: enum: - STANDARD - RTCOMMS type: string x-spec-enum-id: b79aa7aeab4396fd description: |- Method used to uplink scheduling information to the satellite * `STANDARD` - Standard * `RTCOMMS` - RT Comms downlink_method: enum: - STANDARD - RTCOMMS type: string x-spec-enum-id: b79aa7aeab4396fd description: |- Method used to downlink imagery from the satellite * `STANDARD` - Standard * `RTCOMMS` - RT Comms cloud_forecast: type: array items: $ref: '#/components/schemas/CloudForecast' readOnly: true nullable: true description: >- Predicted cloud cover for the order. The forecast will be updated periodically, and the array will contain multiple forecast results in chronological order. Only available for Assured Tasking orders. required: - cancellable_until - cancellation_fee_applied - cancellation_period - capture_assessment_invalid_count - capture_assessment_success_count - capture_status_failed_count - capture_status_published_count - cloud_forecast - created_as_waitlisted - created_by - created_time - data_products - estimated_quota_cost - fulfilled_geometry - fulfilled_sqkm - id - is_cancellable - last_acquired_time - max_strip_length - min_strip_length - name - next_planned_acquisition_time - original_geometry_type - point_order_radius - requested_sqkm - status - updated_time - used_quota OrderPayload: type: object properties: id: type: string format: uuid title: Order Payload ID description: Unique identifier of a order payload bulk_process: type: string format: uuid readOnly: true description: Unique identifier of the parent bulk process status: enum: - SUCCESS - FAILURE - PENDING - RUNNING type: string x-spec-enum-id: 8ba725b7e49e2486 description: |- Processing status of the order payload * `SUCCESS` - Success * `FAILURE` - Failure * `PENDING` - Pending * `RUNNING` - Running payload: description: Payload provided when submitting the bulk process error: type: string nullable: true description: Additional context if an error occurred during processing order_id: type: string format: uuid readOnly: true nullable: true description: Unique identifier of the related order required: - bulk_process - order_id - payload OrderPricingDetails: type: object properties: order_id: type: string format: uuid nullable: true description: Unique identifier of an order units: enum: - SQKM - CREDITS type: string description: |- * `SQKM` - Sqkm * `CREDITS` - Credits x-spec-enum-id: 40530f6084312f5d estimated_quota_cost: type: number format: double determined_by: enum: - pricing_model - replaced_orders - dedicated_capacity type: string description: |- * `pricing_model` - Pricing Model * `replaced_orders` - Replaced Orders * `dedicated_capacity` - Dedicated Capacity x-spec-enum-id: c799a2ec2d23c39d pricing_model: $ref: '#/components/schemas/PricingModel' replaced_orders: type: array items: $ref: '#/components/schemas/ReplacedOrder' nullable: true readOnly: true required: - determined_by - estimated_quota_cost - pricing_model - replaced_orders - units OrderPricingRequest: type: object properties: imaging_window: type: string format: uuid title: Imaging Window ID description: >- Imaging window ID to create an order for. Required to place an Assured Tasking order. Cannot be used for other scheduling types. nullable: true geometry: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 - type: object properties: type: type: string enum: - GeometryCollection coordinates: type: array items: oneOf: - type: object properties: type: type: string enum: - Point coordinates: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 - type: object properties: type: type: string enum: - LineString coordinates: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 2 - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number format: float example: - 12.9721 - 77.5933 minItems: 2 maxItems: 3 example: - - 22.4707 - 70.0577 - - 12.9721 - 77.5933 minItems: 4 example: - - - 0 - 0 - - 0 - 50 - - 50 - 50 - - 50 - 0 - - 0 - 0 description: >- GeoJSON representation of a Point, a two-point LineString or a Polygon. A polygon can contain at most 1500 vertices. Point and LineString inputs will be expanded into a circular or rectangle Polygon respectively to serve as the area of interest for this order. The expansion size defaults to 5 km for SkySat imagery but can vary based on product parameters. Required for all orders except Assured Tasking orders. pl_number: type: string nullable: true title: Contract number description: >- Contract number of the order. Required if you have access to multiple products or contracts. product: type: string nullable: true title: Product name description: >- Name of the product of the order. Required if you have access to multiple products or contracts. start_time: type: string format: date-time description: >- Time at which to start acquiring imagery for the order. Defaults to the time of order submission. end_time: type: string format: date-time nullable: true description: >- Latest time by which imagery will be acquired for the order. Defaults to the contract's default order duration (from the time of order submission). n_stereo_pov: enum: - 2 - 3 - null type: integer x-spec-enum-id: 6f8bdde0f4f15994 nullable: true title: Number of stereo captures description: >- Number of captures to be taken for Stereo Tasking orders. The convergence half angle is 15° for 2 stereo captures, and 27.5° for 3 stereo captures. * `2` - 2 * `3` - 3 exclusivity_days: enum: - 0 - 7 - 30 - null type: integer x-spec-enum-id: f91f89160ed49e03 nullable: true description: >- Number of days for the captured imagery to be held exclusive for this order * `0` - 0 * `7` - 7 * `30` - 30 scheduling_type: enum: - FLEXIBLE - LOCK_IN - MONITORING - EXPRESS - ASSURED - ARCHIVE type: string x-spec-enum-id: 3d5d72179084691b description: >- The way the order will be scheduled for capturing imagery. Must match the product. * `FLEXIBLE` - Flexible * `LOCK_IN` - Lock-In * `MONITORING` - Monitoring * `EXPRESS` - Express * `ASSURED` - Assured * `ARCHIVE` - Archive PaginatedBulkSummaryList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/BulkSummary' PaginatedCaptureList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Capture' PaginatedHistoryEventList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/HistoryEvent' PaginatedImagingWindowList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ImagingWindow' PaginatedOrderList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Order' PricingDetails: oneOf: - $ref: '#/components/schemas/OrderPricingDetails' - $ref: '#/components/schemas/BulkOrderPricingDetails' PricingModel: type: object properties: base_price: type: number format: double multipliers: type: array items: $ref: '#/components/schemas/PricingMultiplier' required: - base_price - multipliers PricingMultiplier: type: object properties: name: enum: - scheduling_type - imaging_mode - sensitivity_mode - archive_hold - imaging_window - image_recency - data_products type: string description: |- * `scheduling_type` - Scheduling Type * `imaging_mode` - Imaging Mode * `sensitivity_mode` - Sensitivity Mode * `archive_hold` - Archive Hold * `imaging_window` - Imaging Window * `image_recency` - Image Recency * `data_products` - Data Products x-spec-enum-id: 47ec0d9c49000908 description: oneOf: - type: string - type: array items: type: string value: type: number format: double required: - description - name - value ReplacedOrder: type: object properties: order_id: type: string format: uuid readOnly: true description: Unique identifier of an order name: type: string readOnly: true description: User-defined name of an order cost: type: number format: double readOnly: true description: Cost of an order required: - cost - name - order_id SimpleCloudForecast: type: object properties: prediction: type: number format: double maximum: 100 minimum: 0 readOnly: true nullable: true updated_time: type: string format: date-time readOnly: true required: - prediction - updated_time UpdateOrder: type: object properties: start_time: type: string format: date-time description: >- Time at which to start acquiring imagery for the order. Defaults to the time of order submission. end_time: type: string format: date-time description: >- Latest time by which imagery will be acquired for the order. Defaults to the contract's default order duration (from the time of order submission). UserTaskingPreferences: type: object properties: delivery_option: enum: - CLOUD_DESTINATION - NONE type: string x-spec-enum-id: 8d47bc3d3012cd32 description: |- How the user's future orders are delivered. Possible values are: * `CLOUD_DESTINATION`: Captures are pushed to a customer-owned cloud destination configured on the order * `DIRECT_DOWNLOAD`: Captures are activated for on-demand download in the Tasking Dashboard * `NONE`: No automated delivery is initiated for the user's orders * `CLOUD_DESTINATION` - Cloud destination * `NONE` - None required: - delivery_option securitySchemes: ApiKeyBasicAuth: type: http scheme: basic description: Must pass API key as username and leave password empty ApiKeyInAuthorizationHeaderAuth: type: apiKey in: header name: Authorization description: Must be prefixed with `api-key`. BearerTokenAuth: type: http scheme: bearer bearerFormat: JWT headers: Retry-After: in: header name: Retry-After schema: type: integer description: > Number of seconds to wait before making a new request, as defined by [RFC 7231 sec. 7.1.3](https://www.rfc-editor.org/rfc/rfc7231#section-7.1.3). Limits are listed in the description of each endpoint to which they apply. Each limit is evaluated per user and scope. Requests against endpoints with a specified scope count towards the limit for all endpoints with that scope. required: true examples: - 30 servers: - url: https://api.planet.com description: Planet API tags: - name: Orders description: > A tasking order is a request to capture new imagery of a specific area of interest (AOI) within a given time of interest (TOI). Tasking orders are not to be confused with Scene and Basemap Orders offered by the [Planet Orders API](https://developers.planet.com/apis/orders/). - name: Imaging Windows description: > An imaging window is a distinct opportunity for imagery to be taken by a specific satellite as it passes over an area of interest (AOI) at a given time of interest (TOI). Submitting an Assured Tasking order requires you to specify an imaging window. - name: Captures description: > A capture is a reference to the imagery acquired for the order submitted by the user. - name: Bulk Processes description: > Bulk processes allows you to submit up to 1000 orders in a single request. Upon submission, the orders will be created asynchronously and will become available individually. Orders may also be edited or cancelled in bulk by changing the `operation_type` of the bulk process. - name: Order History description: > The order history provides insights on your orders moving through the stages order process. Whenever an order changes its status, a new history event will be recorded to represent the change. - name: Preferences description: | Preferences allow you to modify the behavior of the Tasking API. - name: Pricing description: | Retrieve pricing information for orders placed via Tasking API.