Copy for LLM[View as Markdown](https://docs.planet.com/develop/apis/tasking/reference/)
# API Reference
* Orders
* getList Tasking Orders
* postCreate Tasking Order
* getRetrieve Tasking Order
* putUpdate Tasking Order
* delCancel Tasking Order
* getRetrieve Order Pricing Information
* Imaging Windows
* getRetrieve Imaging Windows
* postSearch Imaging Windows
* postCreate Asynchronous Imaging Windows Search Request
* getRetrieve Asynchronous Imaging Windows Search Results
* Captures
* getList Captures
* postOpen a capture review
* getRetrieve Capture
* Bulk Processes
* getList Bulk Processes
* postCreate Bulk Order
* getRetrieve Bulk Order
* getRetrieve Bulk Order Payloads
* Order History
* getList Order History
* getRetrieve Order History
* Preferences
* getRetrieve Tasking Preferences
* putUpdate Tasking Preferences
* getList Notification Preferences
* postSet Notification Preferences
* Pricing
* getRetrieve Order Pricing Information
* postRetrieve Pricing Preview
[API docs by Redocly](https://redocly.com/redoc/)
# Planet Tasking API (2.0.0)
Download OpenAPI specification:[Download](https://docs.planet.com/redocusaurus/tasking-api-spec.yaml)
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/).
## [](#tag/Orders)Orders
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/).
## [](#tag/Orders/operation/tasking_v2_orders_list)List Tasking Orders
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`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### query Parameters
| | |
| ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| altitude | integerFilter by the altitude to be equal to the given value |
| altitude\_\_gt | integerFilter by the altitude to be greater than the given value |
| altitude\_\_gte | integerFilter by the altitude to be greater than or equal to the given value |
| altitude\_\_lt | integerFilter by the altitude to be less than the given value |
| altitude\_\_lte | integerFilter by the altitude to be less than or equal to the given value |
| asset\_types | Array of stringsItems 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"Filter by the asset types to be equal to the given value |
| asset\_types\_\_in | Array of strings\[ items ]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"Multiple values may be separated by commas. |
| asset\_types\_\_ne | Array of stringsItems 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"Filter by the asset types to not be equal to the given value |
| asset\_types\_\_notin | Array of strings\[ items ]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"Multiple values may be separated by commas. |
| assured\_tasking\_tier | stringEnum: "EXPRESS" "NOT\_APPLICABLE" "STANDARD"Filter by the assured tasking tier to be equal to the given value- `NOT_APPLICABLE` - Not Applicable
- `STANDARD` - Standard
- `EXPRESS` - Express |
| assured\_tasking\_tier\_\_in | Array of stringsMultiple values may be separated by commas. |
| assured\_tasking\_tier\_\_ne | stringFilter by the assured tasking tier to not be equal to the given value |
| assured\_tasking\_tier\_\_notin | Array of stringsMultiple values may be separated by commas. |
| cancellation\_fee\_applied | booleanFilter by the cancellation fee applied to be equal to the given value |
| cancelled\_by\_replacement | booleanFilter by the cancelled by replacement to be equal to the given value |
| cancelled\_time | string \Filter by the cancelled time to be equal to the given value |
| cancelled\_time\_\_gt | string \Filter by the cancelled time to be greater than the given value |
| cancelled\_time\_\_gte | string \Filter by the cancelled time to be greater than or equal to the given value |
| cancelled\_time\_\_lt | string \Filter by the cancelled time to be less than the given value |
| cancelled\_time\_\_lte | string \Filter by the cancelled time to be less than or equal to the given value |
| capture\_assessment\_invalid\_count | integerFilter by the number of captures assessed invalid to be equal to the given value |
| capture\_assessment\_invalid\_count\_\_gt | integerFilter by the number of captures assessed invalid to be greater than the given value |
| capture\_assessment\_invalid\_count\_\_gte | integerFilter by the number of captures assessed invalid to be greater than or equal to the given value |
| capture\_assessment\_invalid\_count\_\_lt | integerFilter by the number of captures assessed invalid to be less than the given value |
| capture\_assessment\_invalid\_count\_\_lte | integerFilter by the number of captures assessed invalid to be less than or equal to the given value |
| capture\_assessment\_success\_count | integerFilter by the number of captures assessed successful to be equal to the given value |
| capture\_assessment\_success\_count\_\_gt | integerFilter by the number of captures assessed successful to be greater than the given value |
| capture\_assessment\_success\_count\_\_gte | integerFilter by the number of captures assessed successful to be greater than or equal to the given value |
| capture\_assessment\_success\_count\_\_lt | integerFilter by the number of captures assessed successful to be less than the given value |
| capture\_assessment\_success\_count\_\_lte | integerFilter by the number of captures assessed successful to be less than or equal to the given value |
| capture\_count | integerFilter by the capture count to be equal to the given value |
| capture\_count\_\_gt | integerFilter by the capture count to be greater than the given value |
| capture\_count\_\_gte | integerFilter by the capture count to be greater than or equal to the given value |
| capture\_count\_\_lt | integerFilter by the capture count to be less than the given value |
| capture\_count\_\_lte | integerFilter by the capture count to be less than or equal to the given value |
| capture\_status\_deriving\_count | integerFilter by the capture status deriving count to be equal to the given value |
| capture\_status\_deriving\_count\_\_gt | integerFilter by the capture status deriving count to be greater than the given value |
| capture\_status\_deriving\_count\_\_gte | integerFilter by the capture status deriving count to be greater than or equal to the given value |
| capture\_status\_deriving\_count\_\_lt | integerFilter by the capture status deriving count to be less than the given value |
| capture\_status\_deriving\_count\_\_lte | integerFilter by the capture status deriving count to be less than or equal to the given value |
| capture\_status\_failed\_count | integerFilter by the number of failed captures to be equal to the given value |
| capture\_status\_failed\_count\_\_gt | integerFilter by the number of failed captures to be greater than the given value |
| capture\_status\_failed\_count\_\_gte | integerFilter by the number of failed captures to be greater than or equal to the given value |
| capture\_status\_failed\_count\_\_lt | integerFilter by the number of failed captures to be less than the given value |
| capture\_status\_failed\_count\_\_lte | integerFilter by the number of failed captures to be less than or equal to the given value |
| capture\_status\_processing\_count | integerFilter by the number of processing captures to be equal to the given value |
| capture\_status\_processing\_count\_\_gt | integerFilter by the number of processing captures to be greater than the given value |
| capture\_status\_processing\_count\_\_gte | integerFilter by the number of processing captures to be greater than or equal to the given value |
| capture\_status\_processing\_count\_\_lt | integerFilter by the number of processing captures to be less than the given value |
| capture\_status\_processing\_count\_\_lte | integerFilter by the number of processing captures to be less than or equal to the given value |
| capture\_status\_published\_count | integerFilter by the number of published captures to be equal to the given value |
| capture\_status\_published\_count\_\_gt | integerFilter by the number of published captures to be greater than the given value |
| capture\_status\_published\_count\_\_gte | integerFilter by the number of published captures to be greater than or equal to the given value |
| capture\_status\_published\_count\_\_lt | integerFilter by the number of published captures to be less than the given value |
| capture\_status\_published\_count\_\_lte | integerFilter by the number of published captures to be less than or equal to the given value |
| capture\_status\_queued\_count | integerFilter by the number of queued captures to be equal to the given value |
| capture\_status\_queued\_count\_\_gt | integerFilter by the number of queued captures to be greater than the given value |
| capture\_status\_queued\_count\_\_gte | integerFilter by the number of queued captures to be greater than or equal to the given value |
| capture\_status\_queued\_count\_\_lt | integerFilter by the number of queued captures to be less than the given value |
| capture\_status\_queued\_count\_\_lte | integerFilter by the number of queued captures to be less than or equal to the given value |
| cloud\_cover\_max\_\_gt | number \Filter by the maximum cloud coverage to be greater than the given value |
| cloud\_cover\_max\_\_gte | number \Filter by the maximum cloud coverage to be greater than or equal to the given value |
| cloud\_cover\_max\_\_lt | number \Filter by the maximum cloud coverage to be less than the given value |
| cloud\_cover\_max\_\_lte | number \Filter by the maximum cloud coverage to be less than or equal to the given value |
| cloud\_cover\_min\_\_gt | number \Filter by the minimum cloud coverage to be greater than the given value |
| cloud\_cover\_min\_\_gte | number \Filter by the minimum cloud coverage to be greater than or equal to the given value |
| cloud\_cover\_min\_\_lt | number \Filter by the minimum cloud coverage to be less than the given value |
| cloud\_cover\_min\_\_lte | number \Filter by the minimum cloud coverage to be less than or equal to the given value |
| cloud\_threshold | number \Filter by the cloud threshold to be equal to the given value |
| cloud\_threshold\_\_gt | number \Filter by the cloud threshold to be greater than the given value |
| cloud\_threshold\_\_gte | number \Filter by the cloud threshold to be greater than or equal to the given value |
| cloud\_threshold\_\_lt | number \Filter by the cloud threshold to be less than the given value |
| cloud\_threshold\_\_lte | number \Filter by the cloud threshold to be less than or equal to the given value |
| created\_as\_replacement | booleanFilter by the created as replacement to be equal to the given value |
| created\_as\_waitlisted | booleanFilter by the created as waitlisted to be equal to the given value |
| created\_by | stringFilter by the created by to be equal to the given value |
| created\_by\_\_icontains | stringFilter by the created by to contain the given value (case-insensitive) |
| created\_by\_\_in | Array of stringsMultiple values may be separated by commas. |
| created\_by\_\_ne | stringFilter by the created by to not be equal to the given value |
| created\_by\_\_notin | Array of stringsMultiple values may be separated by commas. |
| created\_time | string \Filter by the created time to be equal to the given value |
| created\_time\_\_gt | string \Filter by the created time to be greater than the given value |
| created\_time\_\_gte | string \Filter by the created time to be greater than or equal to the given value |
| created\_time\_\_lt | string \Filter by the created time to be less than the given value |
| created\_time\_\_lte | string \Filter by the created time to be less than or equal to the given value |
| customer\_aoi\_name | stringFilter by the customer aoi name to be equal to the given value |
| customer\_aoi\_name\_\_icontains | stringFilter by the customer aoi name to contain the given value (case-insensitive) |
| customer\_aoi\_name\_\_isnotnull | booleanFilter by the customer aoi name to not be null/unset |
| customer\_aoi\_name\_\_isnull | booleanFilter by the customer aoi name to be null/unset |
| customer\_aoi\_name\_\_ne | stringFilter by the customer aoi name to not be equal to the given value |
| customer\_name | stringFilter by the customer name to be equal to the given value |
| customer\_name\_\_icontains | stringFilter by the customer name to contain the given value (case-insensitive) |
| customer\_name\_\_in | Array of stringsMultiple values may be separated by commas. |
| customer\_name\_\_ne | stringFilter by the customer name to not be equal to the given value |
| customer\_name\_\_notin | Array of stringsMultiple values may be separated by commas. |
| customer\_org\_id | integerFilter by the customer org ID to be equal to the given value |
| customer\_org\_id\_\_in | Array of integersMultiple values may be separated by commas. |
| customer\_org\_id\_\_ne | integerFilter by the customer org ID to not be equal to the given value |
| customer\_org\_id\_\_notin | Array of integersMultiple values may be separated by commas. |
| data\_products | Array of stringsItems Enum: "HIGH\_RESOLUTION\_SCENES" "HYPERSPECTRAL\_SCENES" "TANAGER\_METHANE\_DETECTION"Filter by the data products to be equal to the given value |
| data\_products\_\_in | Array of strings\[ items ]Items Enum: "HIGH\_RESOLUTION\_SCENES" "HYPERSPECTRAL\_SCENES" "TANAGER\_METHANE\_DETECTION"Multiple values may be separated by commas. |
| end\_time | string \Filter by the end time to be equal to the given value |
| end\_time\_\_gt | string \Filter by the end time to be greater than the given value |
| end\_time\_\_gte | string \Filter by the end time to be greater than or equal to the given value |
| end\_time\_\_lt | string \Filter by the end time to be less than the given value |
| end\_time\_\_lte | string \Filter by the end time to be less than or equal to the given value |
| ends\_in\_hours\_\_exact | numberFilter by the ends in hours to be equal to the given value |
| ends\_in\_hours\_\_gt | numberFilter by the ends in hours to be greater than the given value |
| ends\_in\_hours\_\_gte | numberFilter by the ends in hours to be greater than or equal to the given value |
| ends\_in\_hours\_\_lt | numberFilter by the ends in hours to be less than the given value |
| ends\_in\_hours\_\_lte | numberFilter by the ends in hours to be less than or equal to the given value |
| estimated\_quota\_cost | number \Filter by the estimated quota cost to be equal to the given value |
| estimated\_quota\_cost\_\_gt | number \Filter by the estimated quota cost to be greater than the given value |
| estimated\_quota\_cost\_\_gte | number \Filter by the estimated quota cost to be greater than or equal to the given value |
| estimated\_quota\_cost\_\_lt | number \Filter by the estimated quota cost to be less than the given value |
| estimated\_quota\_cost\_\_lte | number \Filter by the estimated quota cost to be less than or equal to the given value |
| exclusivity\_days | integerFilter by the exclusivity days to be equal to the given value |
| exclusivity\_days\_\_gt | integerFilter by the exclusivity days to be greater than the given value |
| exclusivity\_days\_\_gte | integerFilter by the exclusivity days to be greater than or equal to the given value |
| exclusivity\_days\_\_lt | integerFilter by the exclusivity days to be less than the given value |
| exclusivity\_days\_\_lte | integerFilter by the exclusivity days to be less than or equal to the given value |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| format | stringEnum: "csv" "json" |
| fulfilled\_sqkm | number \Filter by the fulfilled square kilometers to be equal to the given value |
| fulfilled\_sqkm\_\_gt | number \Filter by the fulfilled square kilometers to be greater than the given value |
| fulfilled\_sqkm\_\_gte | number \Filter by the fulfilled square kilometers to be greater than or equal to the given value |
| fulfilled\_sqkm\_\_lt | number \Filter by the fulfilled square kilometers to be less than the given value |
| fulfilled\_sqkm\_\_lte | number \Filter by the fulfilled square kilometers to be less than or equal to the given value |
| fulfilled\_time | string \Filter by the fulfilled time to be equal to the given value |
| fulfilled\_time\_\_gt | string \Filter by the fulfilled time to be greater than the given value |
| fulfilled\_time\_\_gte | string \Filter by the fulfilled time to be greater than or equal to the given value |
| fulfilled\_time\_\_lt | string \Filter by the fulfilled time to be less than the given value |
| fulfilled\_time\_\_lte | string \Filter by the fulfilled time to be less than or equal to the given value |
| geometry\_\_centroid\_within | stringFilter by the geometry to have its centroid within the given geometry (GeoJSON or WKT string) |
| geometry\_\_intersects | stringFilter by the geometry to to intersect with the given geometry (GeoJSON or WKT string) |
| ground\_sample\_distance\_max | number \Filter by the maximum ground sample distance to be equal to the given value |
| ground\_sample\_distance\_max\_\_gt | number \Filter by the maximum ground sample distance to be greater than the given value |
| ground\_sample\_distance\_max\_\_gte | number \Filter by the maximum ground sample distance to be greater than or equal to the given value |
| ground\_sample\_distance\_max\_\_lt | number \Filter by the maximum ground sample distance to be less than the given value |
| ground\_sample\_distance\_max\_\_lte | number \Filter by the maximum ground sample distance to be less than or equal to the given value |
| has\_unassessed\_captures | booleanFilter by the has unassessed captures to be equal to the given value |
| id | string \Filter by the id to be equal to the given value |
| id\_\_in | Array of strings \ \[ items \ ]Multiple values may be separated by commas. |
| id\_\_ne | string \Filter by the id to not be equal to the given value |
| id\_\_notin | Array of strings \ \[ items \ ]Multiple values may be separated by commas. |
| imaging\_conops | stringEnum: "dark" "experimental" "flatfield" "glint" "high\_capacity" "high\_data\_volume" "nominal" "video"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 |
| imaging\_conops\_\_in | Array of stringsMultiple values may be separated by commas. |
| imaging\_conops\_\_ne | stringFilter by the imaging collection preset to not be equal to the given value |
| imaging\_conops\_\_notin | Array of stringsMultiple values may be separated by commas. |
| last\_acquired\_time | string \Filter by the last acquired time to be equal to the given value |
| last\_acquired\_time\_\_gt | string \Filter by the last acquired time to be greater than the given value |
| last\_acquired\_time\_\_gte | string \Filter by the last acquired time to be greater than or equal to the given value |
| last\_acquired\_time\_\_lt | string \Filter by the last acquired time to be less than the given value |
| last\_acquired\_time\_\_lte | string \Filter by the last acquired time to be less than or equal to the given value |
| limit | integer \[ 1 .. 1000 ]Number of results to return per page. |
| listing | stringEnum: "hotlisted" "unlisted"Filter by the hotlist to be equal to the given value- `unlisted` - Unlisted
- `hotlisted` - Hotlisted |
| listing\_\_ne | stringFilter by the hotlist to not be equal to the given value |
| n\_stereo\_pov | integer or nullEnum: 2 3Filter by the number of stereo captures to be equal to the given value- `2` - 2
- `3` - 3 |
| n\_stereo\_pov\_\_ne | integerFilter by the number of stereo captures to not be equal to the given value |
| name | stringFilter by the name to be equal to the given value |
| name\_\_icontains | stringFilter by the name to contain the given value (case-insensitive) |
| name\_\_ne | stringFilter by the name to not be equal to the given value |
| name\_ascii | stringFilter by the name ascii to be equal to the given value |
| name\_ascii\_\_icontains | stringFilter by the name ascii to contain the given value (case-insensitive) |
| name\_ascii\_\_ne | stringFilter by the name ascii to not be equal to the given value |
| offset | integer \[ 0 .. 30000 ]The initial index from which to return the results. |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
| order\_type | stringEnum: "IMAGE" "STEREO" "VIDEO"Filter by the order type to be equal to the given value- `IMAGE` - Image
- `VIDEO` - Video
- `STEREO` - Stereo |
| order\_type\_\_in | Array of stringsMultiple values may be separated by commas. |
| order\_type\_\_ne | stringFilter by the order type to not be equal to the given value |
| order\_type\_\_notin | Array of stringsMultiple values may be separated by commas. |
| ordering | stringWhich field to use when ordering the results. |
| original\_geometry\_type | stringEnum: "GeometryCollection" "LineString" "MultiLineString" "MultiPoint" "MultiPolygon" "Point" "Polygon"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 |
| original\_geometry\_type\_\_in | Array of stringsMultiple values may be separated by commas. |
| original\_geometry\_type\_\_ne | stringFilter by the original geometry type to not be equal to the given value |
| original\_geometry\_type\_\_notin | Array of stringsMultiple values may be separated by commas. |
| pending\_quota\_cost | number \Filter by the pending quota cost to be equal to the given value |
| pending\_quota\_cost\_\_gt | number \Filter by the pending quota cost to be greater than the given value |
| pending\_quota\_cost\_\_gte | number \Filter by the pending quota cost to be greater than or equal to the given value |
| pending\_quota\_cost\_\_lt | number \Filter by the pending quota cost to be less than the given value |
| pending\_quota\_cost\_\_lte | number \Filter by the pending quota cost to be less than or equal to the given value |
| pl\_number | stringFilter by the contract number to be equal to the given value |
| pl\_number\_\_icontains | stringFilter by the contract number to contain the given value (case-insensitive) |
| pl\_number\_\_in | Array of stringsMultiple values may be separated by commas. |
| pl\_number\_\_ne | stringFilter by the contract number to not be equal to the given value |
| pl\_number\_\_notin | Array of stringsMultiple values may be separated by commas. |
| priority | integerFilter by the priority to be equal to the given value |
| priority\_\_gt | integerFilter by the priority to be greater than the given value |
| priority\_\_gte | integerFilter by the priority to be greater than or equal to the given value |
| priority\_\_lt | integerFilter by the priority to be less than the given value |
| priority\_\_lte | integerFilter by the priority to be less than or equal to the given value |
| product | stringFilter by the product name to be equal to the given value |
| product\_\_in | Array of stringsMultiple values may be separated by commas. |
| product\_\_ne | stringFilter by the product name to not be equal to the given value |
| product\_\_notin | Array of stringsMultiple values may be separated by commas. |
| progress | number \Filter by the progress to be equal to the given value |
| progress\_\_gt | number \Filter by the progress to be greater than the given value |
| progress\_\_gte | number \Filter by the progress to be greater than or equal to the given value |
| progress\_\_lt | number \Filter by the progress to be less than the given value |
| progress\_\_lte | number \Filter by the progress to be less than or equal to the given value |
| quota\_units | string or nullEnum: "CREDITS" "SQKM"Filter by the quota units to be equal to the given value- `SQKM` - Sqkm
- `CREDITS` - Credits |
| rank | integerFilter by the rank to be equal to the given value |
| rank\_\_gt | integerFilter by the rank to be greater than the given value |
| rank\_\_gte | integerFilter by the rank to be greater than or equal to the given value |
| rank\_\_lt | integerFilter by the rank to be less than the given value |
| rank\_\_lte | integerFilter by the rank to be less than or equal to the given value |
| requested\_sqkm | number \Filter by the requested square kilometers to be equal to the given value |
| requested\_sqkm\_\_gt | number \Filter by the requested square kilometers to be greater than the given value |
| requested\_sqkm\_\_gte | number \Filter by the requested square kilometers to be greater than or equal to the given value |
| requested\_sqkm\_\_lt | number \Filter by the requested square kilometers to be less than the given value |
| requested\_sqkm\_\_lte | number \Filter by the requested square kilometers to be less than or equal to the given value |
| sat\_azimuth\_angle\_max | number \Filter by the maximum satellite azimuth angle to be equal to the given value |
| sat\_azimuth\_angle\_max\_\_gt | number \Filter by the maximum satellite azimuth angle to be greater than the given value |
| sat\_azimuth\_angle\_max\_\_gte | number \Filter by the maximum satellite azimuth angle to be greater than or equal to the given value |
| sat\_azimuth\_angle\_max\_\_lt | number \Filter by the maximum satellite azimuth angle to be less than the given value |
| sat\_azimuth\_angle\_max\_\_lte | number \Filter by the maximum satellite azimuth angle to be less than or equal to the given value |
| sat\_azimuth\_angle\_min | number \Filter by the minimum satellite azimuth angle to be equal to the given value |
| sat\_azimuth\_angle\_min\_\_gt | number \Filter by the minimum satellite azimuth angle to be greater than the given value |
| sat\_azimuth\_angle\_min\_\_gte | number \Filter by the minimum satellite azimuth angle to be greater than or equal to the given value |
| sat\_azimuth\_angle\_min\_\_lt | number \Filter by the minimum satellite azimuth angle to be less than the given value |
| sat\_azimuth\_angle\_min\_\_lte | number \Filter by the minimum satellite azimuth angle to be less than or equal to the given value |
| sat\_elevation\_angle\_max | number \Filter by the maximum satellite elevation angle to be equal to the given value |
| sat\_elevation\_angle\_max\_\_gt | number \Filter by the maximum satellite elevation angle to be greater than the given value |
| sat\_elevation\_angle\_max\_\_gte | number \Filter by the maximum satellite elevation angle to be greater than or equal to the given value |
| sat\_elevation\_angle\_max\_\_lt | number \Filter by the maximum satellite elevation angle to be less than the given value |
| sat\_elevation\_angle\_max\_\_lte | number \Filter by the maximum satellite elevation angle to be less than or equal to the given value |
| sat\_elevation\_angle\_min | number \Filter by the minimum satellite elevation angle to be equal to the given value |
| sat\_elevation\_angle\_min\_\_gt | number \Filter by the minimum satellite elevation angle to be greater than the given value |
| sat\_elevation\_angle\_min\_\_gte | number \Filter by the minimum satellite elevation angle to be greater than or equal to the given value |
| sat\_elevation\_angle\_min\_\_lt | number \Filter by the minimum satellite elevation angle to be less than the given value |
| sat\_elevation\_angle\_min\_\_lte | number \Filter by the minimum satellite elevation angle to be less than or equal to the given value |
| satellite\_hw\_ids | Array of strings\[ items <= 10 characters ]Filter by the satellite hw IDs to be equal to the given value |
| satellite\_hw\_ids\_\_in | Array of strings\[ items\[ items <= 10 characters ] ]Multiple values may be separated by commas. |
| satellite\_hw\_ids\_\_ne | Array of strings\[ items <= 10 characters ]Filter by the satellite hw IDs to not be equal to the given value |
| satellite\_hw\_ids\_\_notin | Array of strings\[ items\[ items <= 10 characters ] ]Multiple values may be separated by commas. |
| satellite\_types | Array of stringsItems Enum: "SKYSAT" "PELICAN" "TANAGER"Filter by the satellite types to be equal to the given value |
| satellite\_types\_\_in | Array of strings\[ items ]Items Enum: "SKYSAT" "PELICAN" "TANAGER"Multiple values may be separated by commas. |
| scheduling\_type | stringEnum: "ARCHIVE" "ASSURED" "EXPRESS" "FLEXIBLE" "LOCK\_IN" "MONITORING"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 |
| scheduling\_type\_\_in | Array of stringsMultiple values may be separated by commas. |
| scheduling\_type\_\_ne | stringFilter by the scheduling type to not be equal to the given value |
| scheduling\_type\_\_notin | Array of stringsMultiple values may be separated by commas. |
| sensitivity\_mode | stringEnum: "GLINT" "HIGH" "MAX" "MEDIUM" "NOT\_APPLICABLE" "PUSHBROOM" "STANDARD"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 |
| sensitivity\_mode\_\_in | Array of stringsMultiple values may be separated by commas. |
| sensitivity\_mode\_\_ne | stringFilter by the sensitivity mode to not be equal to the given value |
| sensitivity\_mode\_\_notin | Array of stringsMultiple values may be separated by commas. |
| solar\_azimuth\_angle\_max | number \Filter by the maximum solar azimuth angle to be equal to the given value |
| solar\_azimuth\_angle\_max\_\_gt | number \Filter by the maximum solar azimuth angle to be greater than the given value |
| solar\_azimuth\_angle\_max\_\_gte | number \Filter by the maximum solar azimuth angle to be greater than or equal to the given value |
| solar\_azimuth\_angle\_max\_\_lt | number \Filter by the maximum solar azimuth angle to be less than the given value |
| solar\_azimuth\_angle\_max\_\_lte | number \Filter by the maximum solar azimuth angle to be less than or equal to the given value |
| solar\_azimuth\_angle\_min | number \Filter by the minimum solar azimuth angle to be equal to the given value |
| solar\_azimuth\_angle\_min\_\_gt | number \Filter by the minimum solar azimuth angle to be greater than the given value |
| solar\_azimuth\_angle\_min\_\_gte | number \Filter by the minimum solar azimuth angle to be greater than or equal to the given value |
| solar\_azimuth\_angle\_min\_\_lt | number \Filter by the minimum solar azimuth angle to be less than the given value |
| solar\_azimuth\_angle\_min\_\_lte | number \Filter by the minimum solar azimuth angle to be less than or equal to the given value |
| solar\_zenith\_angle\_max | number \Filter by the maximum solar zenith angle to be equal to the given value |
| solar\_zenith\_angle\_max\_\_gt | number \Filter by the maximum solar zenith angle to be greater than the given value |
| solar\_zenith\_angle\_max\_\_gte | number \Filter by the maximum solar zenith angle to be greater than or equal to the given value |
| solar\_zenith\_angle\_max\_\_lt | number \Filter by the maximum solar zenith angle to be less than the given value |
| solar\_zenith\_angle\_max\_\_lte | number \Filter by the maximum solar zenith angle to be less than or equal to the given value |
| solar\_zenith\_angle\_min | number \Filter by the minimum solar zenith angle to be equal to the given value |
| solar\_zenith\_angle\_min\_\_gt | number \Filter by the minimum solar zenith angle to be greater than the given value |
| solar\_zenith\_angle\_min\_\_gte | number \Filter by the minimum solar zenith angle to be greater than or equal to the given value |
| solar\_zenith\_angle\_min\_\_lt | number \Filter by the minimum solar zenith angle to be less than the given value |
| solar\_zenith\_angle\_min\_\_lte | number \Filter by the minimum solar zenith angle to be less than or equal to the given value |
| start\_time | string \Filter by the start time to be equal to the given value |
| start\_time\_\_gt | string \Filter by the start time to be greater than the given value |
| start\_time\_\_gte | string \Filter by the start time to be greater than or equal to the given value |
| start\_time\_\_lt | string \Filter by the start time to be less than the given value |
| start\_time\_\_lte | string \Filter by the start time to be less than or equal to the given value |
| status | stringEnum: "CANCELLED" "EXPIRED" "FAILED" "FINALIZING" "FULFILLED" "IN\_PROGRESS" "PENDING" "PENDING\_CANCELLATION" "RECEIVED" "REJECTED" "REQUESTED" "WAITLISTED" "WAITLIST\_ABANDONED" "WAITLIST\_EXPIRED"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 |
| status\_\_in | Array of stringsMultiple values may be separated by commas. |
| status\_\_ne | stringFilter by the status to not be equal to the given value |
| status\_\_notin | Array of stringsMultiple values may be separated by commas. |
| target\_coverage\_min | number \Filter by the target coverage min to be equal to the given value |
| target\_coverage\_min\_\_gt | number \Filter by the target coverage min to be greater than the given value |
| target\_coverage\_min\_\_gte | number \Filter by the target coverage min to be greater than or equal to the given value |
| target\_coverage\_min\_\_lt | number \Filter by the target coverage min to be less than the given value |
| target\_coverage\_min\_\_lte | number \Filter by the target coverage min to be less than or equal to the given value |
| task\_count | integerFilter by the task count to be equal to the given value |
| task\_count\_\_gt | integerFilter by the task count to be greater than the given value |
| task\_count\_\_gte | integerFilter by the task count to be greater than or equal to the given value |
| task\_count\_\_lt | integerFilter by the task count to be less than the given value |
| task\_count\_\_lte | integerFilter by the task count to be less than or equal to the given value |
| total\_delivered\_sqkm | number \Filter by the total delivered square kilometers to be equal to the given value |
| total\_delivered\_sqkm\_\_gt | number \Filter by the total delivered square kilometers to be greater than the given value |
| total\_delivered\_sqkm\_\_gte | number \Filter by the total delivered square kilometers to be greater than or equal to the given value |
| total\_delivered\_sqkm\_\_lt | number \Filter by the total delivered square kilometers to be less than the given value |
| total\_delivered\_sqkm\_\_lte | number \Filter by the total delivered square kilometers to be less than or equal to the given value |
| updated\_time | string \Filter by the updated time to be equal to the given value |
| updated\_time\_\_gt | string \Filter by the updated time to be greater than the given value |
| updated\_time\_\_gte | string \Filter by the updated time to be greater than or equal to the given value |
| updated\_time\_\_lt | string \Filter by the updated time to be less than the given value |
| updated\_time\_\_lte | string \Filter by the updated time to be less than or equal to the given value |
| used\_quota | number \Filter by the used quota to be equal to the given value |
| used\_quota\_\_gt | number \Filter by the used quota to be greater than the given value |
| used\_quota\_\_gte | number \Filter by the used quota to be greater than or equal to the given value |
| used\_quota\_\_lt | number \Filter by the used quota to be less than the given value |
| used\_quota\_\_lte | number \Filter by the used quota to be less than or equal to the given value |
| user\_id | integerFilter by the user ID to be equal to the given value |
| user\_id\_\_in | Array of integersMultiple values may be separated by commas. |
| user\_id\_\_ne | integerFilter by the user ID to not be equal to the given value |
| user\_id\_\_notin | Array of integersMultiple values may be separated by commas. |
| user\_org\_id | integerFilter by the user org ID to be equal to the given value |
| user\_org\_id\_\_in | Array of integersMultiple values may be separated by commas. |
| user\_org\_id\_\_ne | integerFilter by the user org ID to not be equal to the given value |
| user\_org\_id\_\_notin | Array of integersMultiple values may be separated by commas. |
### Responses
**200**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
get/tasking/v2/orders/
Planet API
https\://api.planet.com/tasking/v2/orders/
### Response samples
* 200
Content type
application/jsonapplication/json
Copy
Expand all Collapse all
`{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"imaging_window": "a1da9ea0-27e5-48b8-87e5-6fbff34aa067",
"geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"original_geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"fulfilled_geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"capture_count": 2147483647,
"capture_status_queued_count": 2147483647,
"capture_status_processing_count": 2147483647,
"capture_status_failed_count": 2147483647,
"capture_status_published_count": 2147483647,
"capture_assessment_success_count": 2147483647,
"capture_assessment_invalid_count": 2147483647,
"order_type": "IMAGE",
"fulfilled_time": "2019-08-24T14:15:22Z",
"pl_number": "string",
"product": "string",
"sat_elevation_angle_min": 15,
"sat_elevation_angle_max": 15,
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"early_start": true,
"cloud_threshold": 1,
"satellite_types": [
"SKYSAT"
],
"data_products": [
"HIGH_RESOLUTION_SCENES"
],
"n_stereo_pov": 2,
"is_cancellable": true,
"cancellable_until": "2019-08-24T14:15:22Z",
"requested_sqkm": 0.1,
"fulfilled_sqkm": 0.1,
"next_planned_acquisition_time": "2019-08-24T14:15:22Z",
"exclusivity_days": 0,
"created_by": "string",
"requested_item_ids": [
"string"
],
"created_time": "2019-08-24T14:15:22Z",
"updated_time": "2019-08-24T14:15:22Z",
"name": "string",
"status": "RECEIVED",
"original_geometry_type": "Point",
"capture_status_deriving_count": 2147483647,
"scheduling_type": "FLEXIBLE",
"rrule": "string",
"cancellation_period": "string",
"cancellation_fee_applied": true,
"created_as_waitlisted": true,
"last_acquired_time": "2019-08-24T14:15:22Z",
"estimated_quota_cost": 0.1,
"used_quota": 0.1,
"min_strip_length": 0.1,
"max_strip_length": 0.1,
"point_order_radius": 0.1,
"asset_types": [
"ortho_visual"
],
"sensitivity_mode": "NOT_APPLICABLE",
"integrations_per_line": 32767,
"integration_ms": 32767,
"uplink_method": "STANDARD",
"downlink_method": "STANDARD"
}
]
}`
## [](#tag/Orders/operation/tasking_v2_orders_create)Create Tasking Order
Submit a new tasking order.
### Rate Limits
* 300 requests/minute (scope: `sustained`)
* 40 requests/second (scope: `burst`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### query Parameters
| | |
| ------ | ---------------------------------------------------------------------------------------------------------------------- |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| format | stringEnum: "csv" "json" |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
##### Request Body schema: application/jsonrequired
| | |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| imaging\_window | string or null \ (Imaging Window ID)Imaging window ID to create an order for. Required to place an Assured Tasking order. Cannot be used for other scheduling types. |
| geometry | object or object or object or object or object or object or objectGeoJSON 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 | (object or null) or (object or null) or (object or null) or (object or null) or (object or null) or (object or null) or (object or null)GeoJSON representation of the original `geometry` submitted when the order was created |
| capture\_count | integer \[ 0 .. 2147483647 ]Number of captures to be taken to fulfill the order |
| capture\_status\_queued\_count | integer (Number of queued captures) \[ 0 .. 2147483647 ]Number of captures currently scheduled for acquisition on a satellite |
| capture\_status\_processing\_count | integer (Number of processing captures) \[ 0 .. 2147483647 ]Number of captures currently being processed by Planet's image processing pipeline |
| order\_type | stringEnum: "IMAGE" "STEREO"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 | string or null \Time the order was fulfilled |
| pl\_number | string or null (Contract number)Contract number of the order. Required if you have access to multiple products or contracts. |
| product | string or null (Product name)Name of the product of the order. Required if you have access to multiple products or contracts. |
| sat\_elevation\_angle\_min | number \ (Minimum satellite elevation angle) \[ 15 .. 90 ]Minimum elevation of the satellite to acquire imagery for the order |
| sat\_elevation\_angle\_max | number \ (Maximum satellite elevation angle) \[ 15 .. 90 ]Maximum elevation of the satellite to acquire imagery for the order |
| start\_time | string \Time at which to start acquiring imagery for the order. Defaults to the time of order submission. |
| end\_time | string or null \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 | boolean or nullWhether 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 | number \ \[ 0 .. 1 ]Cloud coverage threshold for an order to be scheduled for imaging |
| satellite\_types | Array of strings non-emptyItems Enum: "SKYSAT" "PELICAN" "TANAGER"Satellite types to acquire the imagery for the order |
| n\_stereo\_pov | integer or null (Number of stereo captures)Enum: 2 3 nullNumber 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 | integer or nullEnum: 0 7 30 nullNumber of days for the captured imagery to be held exclusive for this order- `0` - 0
- `7` - 7
- `30` - 30 |
| requested\_item\_ids | Array of stringsRequested item IDs for Archive Tasking orders. Cannot be used for other scheduling types. |
| namerequired | stringUser-defined name of an order |
| capture\_status\_deriving\_count | integer \[ 0 .. 2147483647 ]Number of captures that have been published, but some requested assets are still being processed |
| scheduling\_type | stringEnum: "FLEXIBLE" "LOCK\_IN" "MONITORING" "EXPRESS" "ASSURED" "ARCHIVE"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 | string or null (Frequency)Rrule used to schedule individual captures of the order. Only available for Monitoring Tasking orders. |
| asset\_types | Array of stringsItems 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"Derived asset types to be generated for the order |
| sensitivity\_mode | stringEnum: "NOT\_APPLICABLE" "GLINT" "STANDARD" "MEDIUM" "HIGH" "MAX" "PUSHBROOM"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 | integer or null \[ 0 .. 32767 ]Number of integrations per line should be performed via the sensitivity mode. This is an internal numerical interpretation of that mode. |
| integration\_ms | integer or null \[ 0 .. 32767 ]Duration of a single integration during a hyperspectral imagery capture (in milliseconds). This is an experimental setting, and not widely available. |
| uplink\_method | stringEnum: "STANDARD" "RTCOMMS"Method used to uplink scheduling information to the satellite- `STANDARD` - Standard
- `RTCOMMS` - RT Comms |
| downlink\_method | stringEnum: "STANDARD" "RTCOMMS"Method used to downlink imagery from the satellite- `STANDARD` - Standard
- `RTCOMMS` - RT Comms |
### Responses
**201**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
post/tasking/v2/orders/
Planet API
https\://api.planet.com/tasking/v2/orders/
### Request samples
* Payload
Content type
application/json
Copy
Expand all Collapse all
`{
"imaging_window": "a1da9ea0-27e5-48b8-87e5-6fbff34aa067",
"geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"original_geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"capture_count": 2147483647,
"capture_status_queued_count": 2147483647,
"capture_status_processing_count": 2147483647,
"order_type": "IMAGE",
"fulfilled_time": "2019-08-24T14:15:22Z",
"pl_number": "string",
"product": "string",
"sat_elevation_angle_min": 15,
"sat_elevation_angle_max": 15,
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"early_start": true,
"cloud_threshold": 1,
"satellite_types": [
"SKYSAT"
],
"n_stereo_pov": 2,
"exclusivity_days": 0,
"requested_item_ids": [
"string"
],
"name": "string",
"capture_status_deriving_count": 2147483647,
"scheduling_type": "FLEXIBLE",
"rrule": "string",
"asset_types": [
"ortho_visual"
],
"sensitivity_mode": "NOT_APPLICABLE",
"integrations_per_line": 32767,
"integration_ms": 32767,
"uplink_method": "STANDARD",
"downlink_method": "STANDARD"
}`
### Response samples
* 201
Content type
application/jsonapplication/json
Copy
Expand all Collapse all
`{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"imaging_window": "a1da9ea0-27e5-48b8-87e5-6fbff34aa067",
"geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"original_geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"fulfilled_geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"capture_count": 2147483647,
"capture_status_queued_count": 2147483647,
"capture_status_processing_count": 2147483647,
"capture_status_failed_count": 2147483647,
"capture_status_published_count": 2147483647,
"capture_assessment_success_count": 2147483647,
"capture_assessment_invalid_count": 2147483647,
"order_type": "IMAGE",
"fulfilled_time": "2019-08-24T14:15:22Z",
"pl_number": "string",
"product": "string",
"sat_elevation_angle_min": 15,
"sat_elevation_angle_max": 15,
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"early_start": true,
"cloud_threshold": 1,
"satellite_types": [
"SKYSAT"
],
"data_products": [
"HIGH_RESOLUTION_SCENES"
],
"n_stereo_pov": 2,
"is_cancellable": true,
"cancellable_until": "2019-08-24T14:15:22Z",
"requested_sqkm": 0.1,
"fulfilled_sqkm": 0.1,
"next_planned_acquisition_time": "2019-08-24T14:15:22Z",
"exclusivity_days": 0,
"created_by": "string",
"requested_item_ids": [
"string"
],
"created_time": "2019-08-24T14:15:22Z",
"updated_time": "2019-08-24T14:15:22Z",
"name": "string",
"status": "RECEIVED",
"original_geometry_type": "Point",
"capture_status_deriving_count": 2147483647,
"scheduling_type": "FLEXIBLE",
"rrule": "string",
"cancellation_period": "string",
"cancellation_fee_applied": true,
"created_as_waitlisted": true,
"last_acquired_time": "2019-08-24T14:15:22Z",
"estimated_quota_cost": 0.1,
"used_quota": 0.1,
"min_strip_length": 0.1,
"max_strip_length": 0.1,
"point_order_radius": 0.1,
"asset_types": [
"ortho_visual"
],
"sensitivity_mode": "NOT_APPLICABLE",
"integrations_per_line": 32767,
"integration_ms": 32767,
"uplink_method": "STANDARD",
"downlink_method": "STANDARD"
}`
## [](#tag/Orders/operation/tasking_v2_orders_retrieve)Retrieve Tasking Order
Retrieve details of a specific tasking order by its ID.
### Rate Limits
* 300 requests/minute (scope: `sustained`)
* 40 requests/second (scope: `burst`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### path Parameters
| | |
| ---------- | -------------------------------------------------------------- |
| idrequired | string \ (Order ID)A UUID string identifying this order. |
##### query Parameters
| | |
| ------ | ---------------------------------------------------------------------------------------------------------------------- |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| format | stringEnum: "csv" "json" |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
### Responses
**200**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
get/tasking/v2/orders/{id}/
Planet API
https\://api.planet.com/tasking/v2/orders/{id}/
### Response samples
* 200
Content type
application/jsonapplication/json
Copy
Expand all Collapse all
`{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"imaging_window": "a1da9ea0-27e5-48b8-87e5-6fbff34aa067",
"geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"original_geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"fulfilled_geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"capture_count": 2147483647,
"capture_status_queued_count": 2147483647,
"capture_status_processing_count": 2147483647,
"capture_status_failed_count": 2147483647,
"capture_status_published_count": 2147483647,
"capture_assessment_success_count": 2147483647,
"capture_assessment_invalid_count": 2147483647,
"order_type": "IMAGE",
"fulfilled_time": "2019-08-24T14:15:22Z",
"pl_number": "string",
"product": "string",
"sat_elevation_angle_min": 15,
"sat_elevation_angle_max": 15,
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"early_start": true,
"cloud_threshold": 1,
"satellite_types": [
"SKYSAT"
],
"data_products": [
"HIGH_RESOLUTION_SCENES"
],
"n_stereo_pov": 2,
"is_cancellable": true,
"cancellable_until": "2019-08-24T14:15:22Z",
"requested_sqkm": 0.1,
"fulfilled_sqkm": 0.1,
"next_planned_acquisition_time": "2019-08-24T14:15:22Z",
"exclusivity_days": 0,
"created_by": "string",
"requested_item_ids": [
"string"
],
"created_time": "2019-08-24T14:15:22Z",
"updated_time": "2019-08-24T14:15:22Z",
"name": "string",
"status": "RECEIVED",
"original_geometry_type": "Point",
"capture_status_deriving_count": 2147483647,
"scheduling_type": "FLEXIBLE",
"rrule": "string",
"cancellation_period": "string",
"cancellation_fee_applied": true,
"created_as_waitlisted": true,
"last_acquired_time": "2019-08-24T14:15:22Z",
"estimated_quota_cost": 0.1,
"used_quota": 0.1,
"min_strip_length": 0.1,
"max_strip_length": 0.1,
"point_order_radius": 0.1,
"asset_types": [
"ortho_visual"
],
"sensitivity_mode": "NOT_APPLICABLE",
"integrations_per_line": 32767,
"integration_ms": 32767,
"uplink_method": "STANDARD",
"downlink_method": "STANDARD",
"cloud_forecast": [
{
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"prediction": 100,
"historical": 100,
"error_message": "string",
"updated_time": "2019-08-24T14:15:22Z"
}
]
}`
## [](#tag/Orders/operation/tasking_v2_orders_update)Update Tasking Order
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`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### path Parameters
| | |
| ---------- | -------------------------------------------------------------- |
| idrequired | string \ (Order ID)A UUID string identifying this order. |
##### query Parameters
| | |
| ------ | ---------------------------------------------------------------------------------------------------------------------- |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| format | stringEnum: "csv" "json" |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
##### Request Body schema: application/json
| | |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start\_time | string \Time at which to start acquiring imagery for the order. Defaults to the time of order submission. |
| end\_time | string \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). |
### Responses
**200**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
put/tasking/v2/orders/{id}/
Planet API
https\://api.planet.com/tasking/v2/orders/{id}/
### Request samples
* Payload
Content type
application/json
Copy
`{
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
}`
### Response samples
* 200
Content type
application/jsonapplication/json
Copy
`{
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
}`
## [](#tag/Orders/operation/tasking_v2_orders_destroy)Cancel Tasking Order
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`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### path Parameters
| | |
| ---------- | -------------------------------------------------------------- |
| idrequired | string \ (Order ID)A UUID string identifying this order. |
##### query Parameters
| | |
| ------ | ---------------------------------------------------------------------------------------------------------------------- |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| format | stringEnum: "csv" "json" |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
### Responses
**204**
No response body
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
delete/tasking/v2/orders/{id}/
Planet API
https\://api.planet.com/tasking/v2/orders/{id}/
## [](#tag/Orders/operation/tasking_v2_orders_pricing_retrieve)Retrieve Order Pricing Information
Retrieve detailed pricing information for a specific tasking order by its ID.
### Rate Limits
* 300 requests/minute (scope: `sustained`)
* 40 requests/second (scope: `burst`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### path Parameters
| | |
| ---------- | -------------------------------------------------------------- |
| idrequired | string \ (Order ID)A UUID string identifying this order. |
##### query Parameters
| | |
| ------ | ---------------------------------------------------------------------------------------------------------------------- |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| format | stringEnum: "csv" "json" |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
### Responses
**200**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
get/tasking/v2/orders/{id}/pricing/
Planet API
https\://api.planet.com/tasking/v2/orders/{id}/pricing/
### Response samples
* 200
Content type
application/jsonapplication/json
Copy
Expand all Collapse all
`{
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"units": "SQKM",
"estimated_quota_cost": 0.1,
"determined_by": "pricing_model",
"pricing_model": {
"base_price": 0.1,
"multipliers": [
{
"name": "scheduling_type",
"description": "string",
"value": 0.1
}
]
},
"replaced_orders": [
{
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"name": "string",
"cost": 0.1
}
]
}`
## [](#tag/Imaging-Windows)Imaging Windows
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.
## [](#tag/Imaging-Windows/operation/tasking_v2_imaging_windows_list)Retrieve Imaging Windows Deprecated
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`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### query Parameters
| | |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| end\_time | string \Filter by the end time to be equal to the given value |
| end\_time\_\_gt | string \Filter by the end time to be greater than the given value |
| end\_time\_\_gte | string \Filter by the end time to be greater than or equal to the given value |
| end\_time\_\_lt | string \Filter by the end time to be less than the given value |
| end\_time\_\_lte | string \Filter by the end time to be less than or equal to the given value |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| limit | integer \[ 1 .. 1000 ]Number of results to return per page. |
| offset | integer \[ 0 .. 30000 ]The initial index from which to return the results. |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
| ordering | stringWhich field to use when ordering the results. |
| search\_idrequired | string \Filter by the search ID to be equal to the given value |
| search\_request\_id | string \ (Search Request ID)Filter by the search request ID to be equal to the given value |
| show\_replacing\_imaging\_windows | booleanIf 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. |
| show\_waitlistable\_imaging\_windows | booleanIf 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. |
| start\_time | string \Filter by the start time to be equal to the given value |
| start\_time\_\_gt | string \Filter by the start time to be greater than the given value |
| start\_time\_\_gte | string \Filter by the start time to be greater than or equal to the given value |
| start\_time\_\_lt | string \Filter by the start time to be less than the given value |
| start\_time\_\_lte | string \Filter by the start time to be less than or equal to the given value |
### Responses
**200**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
get/tasking/v2/imaging-windows/
Planet API
https\://api.planet.com/tasking/v2/imaging-windows/
### Response samples
* 200
Content type
application/json
Copy
Expand all Collapse all
`{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"geometry": {
"geojson": null
},
"cloud_forecast": [
{
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"prediction": 100,
"historical": 100,
"error_message": "string",
"updated_time": "2019-08-24T14:15:22Z"
}
],
"product": "string",
"pl_number": "string",
"ground_sample_distance_max": 0.1,
"low_light": true,
"conflicting_orders": [ ],
"pricing_details": {
"units": "SQKM",
"estimated_quota_cost": 0.1,
"determined_by": "pricing_model",
"pricing_model": {
"base_price": 0.1,
"multipliers": [
{
"name": "scheduling_type",
"description": "string",
"value": 0.1
}
]
},
"replaced_orders": [
{
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"name": "string",
"cost": 0.1
}
]
},
"only_via_waitlist": true,
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"start_off_nadir": 0.1,
"end_off_nadir": 0.1,
"dedicated_satellite_hw_id": "string",
"created_time": "2019-08-24T14:15:22Z",
"satellite_elevation_angle_min": 0.1,
"satellite_elevation_angle_max": 0.1,
"solar_zenith_angle_min": 0.1,
"solar_zenith_angle_max": 0.1,
"sun_elevation_angle_min": 0.1,
"sun_elevation_angle_max": 0.1,
"sat_azimuth_angle_start": 0.1,
"sat_azimuth_angle_end": 0.1,
"existing_activities": null,
"min_off_nadir": 0.1,
"max_off_nadir": 0.1,
"error_code": "string",
"ground_sample_distance": 0.1,
"assured_tasking_tier": "NOT_APPLICABLE",
"cloud_forecast_initial": 0.1,
"cloud_forecast_latest": 0.1,
"cloud_forecast_latest_updated_time": "2019-08-24T14:15:22Z",
"quota_priority_multiplier": 0.1,
"sensitivity_mode": "NOT_APPLICABLE",
"satellite_type": "SKYSAT",
"search_request": "67551ed6-bc9d-48bb-afb0-6fda01b21f39",
"existing_orders": [ ],
"unknown_tasks": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"reasons_to_discard": [
"string"
],
"is_prepaid": true,
"unavailable_reasons": [
"string"
]
}
]
}`
## [](#tag/Imaging-Windows/operation/tasking_v2_imaging_windows_create)Search Imaging Windows Deprecated
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`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### Request Body schema: application/jsonrequired
| | |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pl\_number | string (Contract number)Contract number of the search request. Required if you have access to multiple products or contracts. |
| product | string (Product name)Name of the product of the search request. Required if you have access to multiple products or contracts. |
| geometryrequired | object or object or object or object or object or object or objectGeoJSON representation of a Point or a two-point LineString to serve as the area of interest for the imaging window search. |
| start\_time | string \Time from which to consider imaging windows. Defaults to now. |
| end\_time | string \Time until which to consider imaging windows. Defaults to 7 days from now. |
| sat\_elevation\_angle\_min | number \ (Minimum satellite elevation angle) \[ 15 .. 90 ]Minimum elevation of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. |
| sat\_elevation\_angle\_max | number \ (Maximum satellite elevation angle) \[ 15 .. 90 ]Maximum elevation of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. |
| off\_nadir\_angle\_min | number \ (Minimum off-nadir angle) \[ 0 .. 65 ]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 | number \ (Maximum off-nadir angle) \[ 0 .. 65 ]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 | number \ (Minimum satellite azimuth angle) \[ -360 .. 360 ]Minimum satellite azimuth angle during the imaging window. |
| sat\_azimuth\_angle\_max | number \ (Maximum satellite azimuth angle) \[ -360 .. 360 ]Maximum satellite azimuth angle during the imaging window. |
| solar\_zenith\_angle\_min | number \ (Minimum solar zenith angle) \[ 0 .. 90 ]Minimum solar zenith angle during the imaging window. |
| solar\_zenith\_angle\_max | number \ (Maximum solar zenith angle) \[ 0 .. 90 ]Maximum solar zenith angle during the imaging window. |
| solar\_azimuth\_angle\_min | number \ (Minimum solar azimuth angle) \[ -360 .. 360 ]Minimum solar azimuth angle during the imaging window. |
| solar\_azimuth\_angle\_max | number \ (Maximum solar azimuth angle) \[ -360 .. 360 ]Maximum solar azimuth angle during the imaging window. |
| satellite\_types | Array of strings non-emptyItems Enum: "SKYSAT" "PELICAN" "TANAGER"Satellite types to search for imaging windows for. |
| sensitivity\_mode | stringEnum: "NOT\_APPLICABLE" "GLINT" "STANDARD" "MEDIUM" "HIGH" "MAX" "PUSHBROOM"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 |
### Responses
**201**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
**503**
Imaging window search is currently unavailable.
post/tasking/v2/imaging-windows/
Planet API
https\://api.planet.com/tasking/v2/imaging-windows/
### Request samples
* Payload
Content type
application/json
Copy
Expand all Collapse all
`{
"pl_number": "string",
"product": "string",
"geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"sat_elevation_angle_min": 15,
"sat_elevation_angle_max": 15,
"off_nadir_angle_min": 65,
"off_nadir_angle_max": 65,
"sat_azimuth_angle_min": -360,
"sat_azimuth_angle_max": -360,
"solar_zenith_angle_min": 90,
"solar_zenith_angle_max": 90,
"solar_azimuth_angle_min": -360,
"solar_azimuth_angle_max": -360,
"satellite_types": [
"SKYSAT"
],
"sensitivity_mode": "NOT_APPLICABLE"
}`
### Response samples
* 201
Content type
application/json
Copy
`{
"location": "http://example.com"
}`
## [](#tag/Imaging-Windows/operation/tasking_v2_imaging_windows_search_create)Create Asynchronous Imaging Windows Search Request
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`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### query Parameters
| | |
| ------ | ---------------------------------------------------------------------------------------------------------------------- |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
##### Request Body schema: application/jsonrequired
| | |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pl\_number | string (Contract number)Contract number of the search request. Required if you have access to multiple products or contracts. |
| product | string (Product name)Name of the product of the search request. Required if you have access to multiple products or contracts. |
| geometryrequired | object or object or object or object or object or object or objectGeoJSON representation of a Point or a two-point LineString to serve as the area of interest for the imaging window search. |
| start\_time | string \Time from which to consider imaging windows. Defaults to now. |
| end\_time | string \Time until which to consider imaging windows. Defaults to 7 days from now. |
| sat\_elevation\_angle\_min | number \ (Minimum satellite elevation angle) \[ 15 .. 90 ]Minimum elevation of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. |
| sat\_elevation\_angle\_max | number \ (Maximum satellite elevation angle) \[ 15 .. 90 ]Maximum elevation of the satellite during the imaging window. Passing satellite elevation and off-nadir angle ranges is mutually exclusive. |
| off\_nadir\_angle\_min | number \ (Minimum off-nadir angle) \[ 0 .. 65 ]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 | number \ (Maximum off-nadir angle) \[ 0 .. 65 ]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 | number \ (Minimum satellite azimuth angle) \[ -360 .. 360 ]Minimum satellite azimuth angle during the imaging window. |
| sat\_azimuth\_angle\_max | number \ (Maximum satellite azimuth angle) \[ -360 .. 360 ]Maximum satellite azimuth angle during the imaging window. |
| solar\_zenith\_angle\_min | number \ (Minimum solar zenith angle) \[ 0 .. 90 ]Minimum solar zenith angle during the imaging window. |
| solar\_zenith\_angle\_max | number \ (Maximum solar zenith angle) \[ 0 .. 90 ]Maximum solar zenith angle during the imaging window. |
| solar\_azimuth\_angle\_min | number \ (Minimum solar azimuth angle) \[ -360 .. 360 ]Minimum solar azimuth angle during the imaging window. |
| solar\_azimuth\_angle\_max | number \ (Maximum solar azimuth angle) \[ -360 .. 360 ]Maximum solar azimuth angle during the imaging window. |
| satellite\_types | Array of strings non-emptyItems Enum: "SKYSAT" "PELICAN" "TANAGER"Satellite types to search for imaging windows for. |
| sensitivity\_mode | stringEnum: "NOT\_APPLICABLE" "GLINT" "STANDARD" "MEDIUM" "HIGH" "MAX" "PUSHBROOM"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 |
### Responses
**201**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
post/tasking/v2/imaging-windows/search/
Planet API
https\://api.planet.com/tasking/v2/imaging-windows/search/
### Request samples
* Payload
Content type
application/json
Copy
Expand all Collapse all
`{
"pl_number": "string",
"product": "string",
"geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"sat_elevation_angle_min": 15,
"sat_elevation_angle_max": 15,
"off_nadir_angle_min": 65,
"off_nadir_angle_max": 65,
"sat_azimuth_angle_min": -360,
"sat_azimuth_angle_max": -360,
"solar_zenith_angle_min": 90,
"solar_zenith_angle_max": 90,
"solar_azimuth_angle_min": -360,
"solar_azimuth_angle_max": -360,
"satellite_types": [
"SKYSAT"
],
"sensitivity_mode": "NOT_APPLICABLE"
}`
### Response samples
* 201
Content type
application/json
Copy
Expand all Collapse all
`{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"imaging_windows": [ ],
"status": "CREATED",
"pl_number": "string",
"product": "string",
"geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"sat_elevation_angle_min": 15,
"sat_elevation_angle_max": 15,
"off_nadir_angle_min": 65,
"off_nadir_angle_max": 65,
"sat_azimuth_angle_min": -360,
"sat_azimuth_angle_max": -360,
"solar_zenith_angle_min": 90,
"solar_zenith_angle_max": 90,
"solar_azimuth_angle_min": -360,
"solar_azimuth_angle_max": -360,
"error_code": "INTERNAL_ERROR",
"error_message": "string"
}`
## [](#tag/Imaging-Windows/operation/tasking_v2_imaging_windows_search_retrieve)Retrieve Asynchronous Imaging Windows Search Results
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`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### path Parameters
| | |
| ---------- | --------------------------------------------------------------------------- |
| idrequired | string \ (Search Request ID)UUID of the Imaging Window Search Request |
##### query Parameters
| | |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| omit | stringComma-separated list of fields to exclude from the response. If not provided, all available fields are returned. |
| show\_replacing\_imaging\_windows | booleanIf 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. |
| show\_waitlistable\_imaging\_windows | booleanIf 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. |
### Responses
**200**
**400**
Invalid request.
**401**
Unauthorized.
**403**
Insufficient privileges.
**429**
Request throttled (too many requests).
get/tasking/v2/imaging-windows/search/{id}/
Planet API
https\://api.planet.com/tasking/v2/imaging-windows/search/{id}/
### Response samples
* 200
Content type
application/json
Copy
Expand all Collapse all
`{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"imaging_windows": [ ],
"status": "CREATED",
"pl_number": "string",
"product": "string",
"geometry": {
"type": "Point",
"coordinates": [
12.9721,
77.5933
]
},
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"sat_elevation_angle_min": 15,
"sat_elevation_angle_max": 15,
"off_nadir_angle_min": 65,
"off_nadir_angle_max": 65,
"sat_azimuth_angle_min": -360,
"sat_azimuth_angle_max": -360,
"solar_zenith_angle_min": 90,
"solar_zenith_angle_max": 90,
"solar_azimuth_angle_min": -360,
"solar_azimuth_angle_max": -360,
"error_code": "INTERNAL_ERROR",
"error_message": "string"
}`
## [](#tag/Captures)Captures
A capture is a reference to the imagery acquired for the order submitted by the user.
## [](#tag/Captures/operation/tasking_v2_captures_list)List Captures
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`)
##### Authorizations:
*BearerTokenAuth**ApiKeyBasicAuth**ApiKeyInAuthorizationHeaderAuth*
##### query Parameters
| | |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| acquired\_time | string \Filter by the acquired time to be equal to the given value |
| acquired\_time\_\_gt | string \Filter by the acquired time to be greater than the given value |
| acquired\_time\_\_gte | string \Filter by the acquired time to be greater than or equal to the given value |
| acquired\_time\_\_lt | string \Filter by the acquired time to be less than the given value |
| acquired\_time\_\_lte | string \Filter by the acquired time to be less than or equal to the given value |
| aqua\_assessment | string or nullEnum: "ATTEMPT" "INVALID" "SUCCESS"Filter by the aqua assessment to be equal to the given value- `SUCCESS` - Success
- `ATTEMPT` - Attempt
- `INVALID` - Invalid |
| aqua\_assessment\_\_in | Array of stringsMultiple values may be separated by commas. |
| archive\_time | string \Filter by the archive time to be equal to the given value |
| archive\_time\_\_gt | string \Filter by the archive time to be greater than the given value |
| archive\_time\_\_gte | string \Filter by the archive time to be greater than or equal to the given value |
| archive\_time\_\_lt | string \Filter by the archive time to be less than the given value |
| archive\_time\_\_lte | string \Filter by the archive time to be less than or equal to the given value |
| assessment | string or nullEnum: "ATTEMPT" "INVALID" "SUCCESS"Filter by the assessment to be equal to the given value- `SUCCESS` - Success
- `ATTEMPT` - Attempt
- `INVALID` - Invalid |
| assessment\_\_in | Array of stringsMultiple values may be separated by commas. |
| assessment\_\_isnotnull | booleanFilter by the assessment to not be null/unset |
| assessment\_\_isnull | booleanFilter by the assessment to be null/unset |
| assessment\_time | string \Filter by the assessment time to be equal to the given value |
| assessment\_time\_\_gt | string \Filter by the assessment time to be greater than the given value |
| assessment\_time\_\_gte | string \Filter by the assessment time to be greater than or equal to the given value |
| assessment\_time\_\_isnotnull | booleanFilter by the assessment time to not be null/unset |
| assessment\_time\_\_isnull | booleanFilter by the assessment time to be null/unset |
| assessment\_time\_\_lt | string \Filter by the assessment time to be less than the given value |
| assessment\_time\_\_lte | string \Filter by the assessment time to be less than or equal to the given value |
| assessment\_user\_email | stringFilter by the assessment user email to be equal to the given value |
| assessment\_user\_email\_\_icontains | stringFilter by the assessment user email to contain the given value (case-insensitive) |
| assessment\_user\_email\_\_in | Array of stringsMultiple values may be separated by commas. |
| assessment\_user\_email\_\_isnotnull | booleanFilter by the assessment user email to not be null/unset |
| assessment\_user\_email\_\_isnull | booleanFilter by the assessment user email to be null/unset |
| assessment\_user\_email\_\_ne | stringFilter by the assessment user email to not be equal to the given value |
| assessment\_user\_email\_\_notin | Array of stringsMultiple values may be separated by commas. |
| cloud\_cover\_\_gt | number \Filter by the cloud cover to be greater than the given value |
| cloud\_cover\_\_gte | number \Filter by the cloud cover to be greater than or equal to the given value |
| cloud\_cover\_\_lt | number \Filter by the cloud cover to be less than the given value |
| cloud\_cover\_\_lte | number \Filter by the cloud cover to be less than or equal to the given value |
| cloud\_cover\_max\_\_gt | number \Filter by the maximum cloud coverage to be greater than the given value |
| cloud\_cover\_max\_\_gte | number \Filter by the maximum cloud coverage to be greater than or equal to the given value |
| cloud\_cover\_max\_\_lt | number \Filter by the maximum cloud coverage to be less than the given value |
| cloud\_cover\_max\_\_lte | number \Filter by the maximum cloud coverage to be less than or equal to the given value |
| combined\_assessment | string or nullEnum: "ATTEMPT" "INVALID" "SUCCESS"Filter by the combined assessment (deprecated, use Evaluation instead) to be equal to the given value- `SUCCESS` - Success
- `ATTEMPT` - Attempt
- `INVALID` - Invalid |
| combined\_assessment\_\_in | Array of stringsMultiple values may be separated by commas. |
| combined\_assessment\_\_isnotnull | booleanFilter by the combined assessment (deprecated, use Evaluation instead) to not be null/unset |
| combined\_assessment\_\_isnull | booleanFilter by the combined assessment (deprecated, use Evaluation instead) to be null/unset |
| created\_time | string \Filter by the created time to be equal to the given value |
| created\_time\_\_gt | string \Filter by the created time to be greater than the given value |
| created\_time\_\_gte | string \Filter by the created time to be greater than or equal to the given value |
| created\_time\_\_lt | string \Filter by the created time to be less than the given value |
| created\_time\_\_lte | string \Filter by the created time to be less than or equal to the given value |
| customer\_aoi\_name | stringFilter by the customer aoi name to be equal to the given value |
| customer\_aoi\_name\_\_icontains | stringFilter by the customer aoi name to contain the given value (case-insensitive) |
| customer\_aoi\_name\_\_isnotnull | booleanFilter by the customer aoi name to not be null/unset |
| customer\_aoi\_name\_\_isnull | booleanFilter by the customer aoi name to be null/unset |
| customer\_aoi\_name\_\_ne | stringFilter by the customer aoi name to not be equal to the given value |
| customer\_org\_id | integerFilter by the customer org ID to be equal to the given value |
| customer\_org\_id\_\_in | Array of integersMultiple values may be separated by commas. |
| customer\_org\_id\_\_ne | integerFilter by the customer org ID to not be equal to the given value |
| customer\_org\_id\_\_notin | Array of integersMultiple values may be separated by commas. |
| delivered\_asset\_types | Array of stringsItems 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"Filter by the delivered asset types to be equal to the given value |
| delivered\_asset\_types\_\_in | Array of strings\[ items ]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"Multiple values may be separated by commas. |
| delivered\_asset\_types\_\_ne | Array of stringsItems 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"Filter by the delivered asset types to not be equal to the given value |
| delivered\_asset\_types\_\_notin | Array of strings\[ items ]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"Multiple values may be separated by commas. |
| downloadable | booleanFilter by the downloadable to be equal to the given value |
| evaluation | stringEnum: "INVALID" "NONE" "SUCCESS"Filter by the evaluation to be equal to the given value- `NONE` - None
- `SUCCESS` - Success
- `INVALID` - Invalid |
| expired\_time | string \Filter by the expired time to be equal to the given value |
| expired\_time\_\_gt | string \Filter by the expired time to be greater than the given value |
| expired\_time\_\_gte | string \Filter by the expired time to be greater than or equal to the given value |
| expired\_time\_\_lt | string \Filter by the expired time to be less than the given value |
| expired\_time\_\_lte | string \Filter by the expired time to be less than or equal to the given value |
| fast\_rectification\_latency | string \Filter by the fast rectification latency to be equal to the given value |
| fast\_rectification\_latency\_\_gt | string \Filter by the fast rectification latency to be greater than the given value |
| fast\_rectification\_latency\_\_gte | string \Filter by the fast rectification latency to be greater than or equal to the given value |
| fast\_rectification\_latency\_\_lt | string \Filter by the fast rectification latency to be less than the given value |
| fast\_rectification\_latency\_\_lte | string \Filter by the fast rectification latency to be less than or equal to the given value |
| fields | stringComma-separated list of fields to include in the response. If not provided, all available fields are returned. |
| format | stringEnum: "csv" "json" |
| fulfilling | booleanFilter by the fulfilling to be equal to the given value |
| full\_ortho\_latency | string \Filter by the full orthorectification latency to be equal to the given value |
| full\_ortho\_latency\_\_gt | string \Filter by the full orthorectification latency to be greater than the given value |
| full\_ortho\_latency\_\_gte | string \Filter by the full orthorectification latency to be greater than or equal to the given value |
| full\_ortho\_latency\_\_lt | string \Filter by the full orthorectification latency to be less than the given value |
| full\_ortho\_latency\_\_lte | string \Filter by the full orthorectification latency to be less than or equal to the given value |
| ground\_id | string \Filter by the ground ID to be equal to the given value |
| ground\_id\_\_in | Array of strings \ \[ items \ ]Multiple values may be separated by commas. |
| ground\_id\_\_ne | string \Filter by the ground ID to not be equal to the given value |
| ground\_id\_\_notin | Array of strings \ \[ items \ ]Multiple values may be separated by commas. |
| id | string \Filter by the id to be equal to the given value |
| id\_\_in | Array of strings \ \[ items \ ]Multiple values may be separated by commas. |
| id\_\_ne | string \Filter by the id to not be equal to the given value |
| id\_\_notin | Array of strings \ \[ items \ ]Multiple values may be separated by commas. |
| imaging\_conops | stringEnum: "dark" "experimental" "flatfield" "glint" "high\_capacity" "high\_data\_volume" "nominal" "video"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 |
| imaging\_conops\_\_in | Array of stringsMultiple values may be separated by commas. |
| imaging\_conops\_\_ne | stringFilter by the imaging collection preset to not be equal to the given value |
| imaging\_conops\_\_notin | Array of stringsMultiple values may be separated by commas. |
| item\_ids | stringFilter by the item IDs to contain the given value |
| l1a\_latency | string \Filter by the l1A latency to be equal to the given value |
| l1a\_latency\_\_gt | string \Filter by the l1A latency to be greater than the given value |
| l1a\_latency\_\_gte | string \Filter by the l1A latency to be greater than or equal to the given value |
| l1a\_latency\_\_lt | string \Filter by the l1A latency to be less than the given value |
| l1a\_latency\_\_lte | string \Filter by the l1A latency to be less than or equal to the given value |
| limit | integer \[ 1 .. 1000 ]Number of results to return per page. |
| metis\_activity\_id | string \Filter by the metis activity ID to be equal to the given value |
| metis\_activity\_id\_\_in | Array of strings \ \[ items \ ]Multiple values may be separated by commas. |
| needs\_manual\_assessment | booleanFilter by the needs manual assessment to be equal to the given value |
| off\_nadir\_angle\_max | number \Filter by the maximum off-nadir angle to be equal to the given value |
| off\_nadir\_angle\_max\_\_gt | number \