Cell Summary Resource¶
Last updated: August 29, 2022
/metadata/cells/summary
Cell summary requests¶
| http method | path | name | description |
|---|---|---|---|
| POST | /metadata/cells/summary/register | Register a grid cell area | Register a new area for indexing grid cell metadata. |
| POST | /metadata/cells/summary | Retrieve metadata for an AOI | Provide an AOI and get summary metadata for the cells that intersect it. |
| GET | /metadata/cells/{cell_id}/summary | Retrieve summary metadata for a cell | Retrieve metadata for a given cell ID. |
Headers¶
| key | value | description |
|---|---|---|
| Authorization | Bearer {{token}} | Authentication method for ARD API requests. |
| Content-Type | application/json | Applies to POST, PATCH, PUT requests, which require a JSON body. |
Register a grid cell area¶
POST /metadata/cells/summary/register
Request body¶
An AOI is required in the intersects or bbox field.
| parameter | required | description | example |
|---|---|---|---|
| bbox | required if not using "intersects" field | Cannot be used in conjunction with intersects. The bounding box coordinates to which selection results will be limited in [minx, miny, maxx, maxy] format. | "bbox": [-106.8, 35.1, -106.4, 35.4] |
| intersects | required if not using "bbox" field | A WKT or GeoJSON geometry formatted polygon or multipolygon. | "intersects": "POLYGON ((-106.8 35.1,-106.4 35.1,-106.4 35.4,-106.8 35.4,-106.8 35.1))" |
Example:
{
"intersects": "POLYGON ((-106.8 35.1,-106.4 35.1,-106.4 35.4,-106.8 35.4,-106.8 35.1))"
}
Response¶
Provides the cell count for the AOI, and links to the metadata for each found cell.
202 Accepted: Success
Example:
{
"cell_count": 12,
"links": {
"Z18-031131100231": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131100231/summary",
"Z18-031131100233": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131100233/summary",
"Z18-031131100320": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131100320/summary",
"Z18-031131100321": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131100321/summary",
"Z18-031131100322": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131100322/summary",
"Z18-031131100323": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131100323/summary",
"Z18-031131100330": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131100330/summary",
"Z18-031131100332": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131100332/summary",
"Z18-031131102011": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131102011/summary",
"Z18-031131102100": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131102100/summary",
"Z18-031131102101": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131102101/summary",
"Z18-031131102110": "https://ard.maxar.com/api/v1/metadata/cells/Z18-031131102110/summary"
}
}
Retrieve cell metadata for an AOI¶
POST /metadata/cells/summary
Request body¶
An AOI is required in the intersects or bbox field.
| parameter | required | description | example |
|---|---|---|---|
| bbox | required if not using "intersects" field | Cannot be used in conjunction with intersects. The bounding box coordinates to which selection results will be limited in [minx, miny, maxx, maxy] format. | "bbox": [-106.8, 35.1, -106.4, 35.4] |
| intersects | required if not using "bbox" field | A WKT or GeoJSON geometry formatted polygon or multipolygon. | "intersects": "POLYGON ((-106.8 35.1,-106.4 35.1,-106.4 35.4,-106.8 35.4,-106.8 35.1))" |
Example:
{
"intersects": "POLYGON ((-106.8 35.1,-106.4 35.1,-106.4 35.4,-106.8 35.4,-106.8 35.1))"
}
Response¶
Returns a GeoJSON feature collection with summary data for each cell.
| property | description | example |
|---|---|---|
| cell_id | The ID for the cell the feature describes. | "cell_id": "Z13-031133320203" |
| tile_count | The number of tiles that cover the cell. | "tile_count": 82 |
| min_date | The earliest acquisition date for a tile in the cell, in yyyy-mm-dd format. | "min_date": "2011-05-22" |
| min_date_timestamp | The timestamp that accompanies the minimum acquisition date. | "min_date_timestamp": 1306022400| |
| max_date | The most recent acquisition date for a tile in the cell, in yyyy-mm-dd format. | "max_date": "2022-01-23" |
| max_date_timestamp | The time stamp that accompanies the maximum acquisition date. | "max_date_timestamp": 1642896000 |
| platforms | The number of tiles in the cell acquired by the specified satellite. | "platforms": {"worldview-02": 34,"worldview-03": 14} |
| data_percentage_90" | The number of tiles in the cell with 90% data coverage. | "data_percentage_90": 20 |
| data_percentage_75 | The number of tiles in the cell with 75% data coverage. | "data_percentage_75": 23 |
| data_percentage_50 | The number of tiles in the cell with 50% data coverage. | "data_percentage_50": 31 |
| data_percentage_25 | The number of tiles in the cell with 25% data coverage. | "data_percentage_25": 47 |
| cloud_free_percentage_90 | The number of tiles in the cell that are 90% cloud-free. | "cloud_free_percentage_90": 50 |
| cloud_free_percentage_75 | The number of tiles in the cell that are 75% cloud-free. | "cloud_free_percentage_75": 52 |
| cloud_free_percentage_50 | The number of tiles in the cell that are 50% cloud-free. | "cloud_free_percentage_50": 53 |
| cloud_free_percentage_25 | The number of tiles in the cell that are 25% cloud-free. | "cloud_free_percentage_25": 54 |
| created | The date the cell summary data was indexed. | "created": "2022-01-31T13:25:16Z" |
| modified | The date the cell summary data was modified. | "modified": "2022-01-31T13:25:16Z" |
| geometry | The polygon geometry for the AOI. | See example below |
Example GeoJSON feature for a cell:
200 OK: Success
"type": "Feature",
"properties": {
"cell_id": "Z13-031133320203",
"tile_count": 82,
"min_date": "2011-05-22",
"min_date_timestamp": 1306022400,
"max_date": "2022-01-23",
"max_date_timestamp": 1642896000,
"platforms": {
"worldview-02": 34,
"worldview-03": 14,
"geoeye-01": 27,
"worldview-04": 1,
"worldview-01": 6
},
"data_percentage_90": 20,
"data_percentage_75": 23,
"data_percentage_50": 31,
"data_percentage_25": 47,
"cloud_free_percentage_90": 50,
"cloud_free_percentage_75": 52,
"cloud_free_percentage_50": 53,
"cloud_free_percentage_25": 54,
"created": "2022-01-31T13:25:16Z",
"modified": "2022-01-31T13:25:16Z"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-106.64657275298134,
35.141717427553935
],
[
-106.64748158281041,
35.18678472949584
],
[
-106.7023764087391,
35.186025357332746
],
[
-106.70143733134023,
35.140959315429065
],
[
-106.64657275298134,
35.141717427553935
]
]
]
}
}