{"_id":"5b3fab1f17d1710003e05bfd","project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":37,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe","5a96f89c89442e002041144b","5b3f9b7267cbc90003d283a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"category":{"_id":"5b3f9b7267cbc90003d283a5","project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-07-06T16:40:18.797Z","from_sync":false,"order":20,"slug":"vector-tile-generation-and-export","title":"Vector Export Service"},"user":"56267741db1eda0d001c3dbb","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-06T17:47:11.374Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"| Table of Contents |\n| --- |\n| [TileGen Export API Parameters](#section-api-parameters) |\n| [Associated API Calls for TileGen Export](#section-associated-api-calls-for-tilegen-export) |\n\nThese endpoints work in any application.\n\n#API Parameters#\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| callback | String | Body | Callback definition for receiving start/status notifications. If configured, a callback is sent when the tile generation process begins and again when it ends. See [View Export Status](doc:view-export-status) for a description of the information sent in those requests. A URL must be provided for the callback, and optionally, additional header and query parameter information can be configured to be sent with the callback (e.g. for authenticating with the callback receiver). See [Callback Sub-Part Parameters](doc:vector-tile-generation-export-reference-overview#section-tile-param-sub-part-parameters) | Optional |\n| geometry | String | Body | Specifies the area to use in selecting features from Elasticsearch. Only features inside the provided geometry will be included. If not provided, then all documents from the index specified in the 'index' field will be returned. For example, `\"geometry\": { \"type\": \"GeometryCollection\", \"geometries\": [ { \"type\": \"Polygon\", \"coordinates\": [[[1.7,1.9], [1.7,2.5],[2.5,2.5],[2.5,1.9],[1.7,1.9]]] }` | Optional |\n| index | String | Body | The Elasticsearch index/alias pattern to use when querying data. For example, `\"index\": \"vector-gbdx-alphla-catalog-v2*\"` | Required |\n| query | String | Body | An Elasticsearch query used to refine the query. If this field is a string value, it's treated as an ES query_string query. If it's a JSON object, it's interpreted as an Elasticsearch query object. See the Elasticsearch query DSL documentation for more details. If the query is not provided, then all documents from the index specified in the 'index' field will be returned. For example, `\"query\": { \"query_string\": { \"query\": \"item_type: SENTINEL2\" } }` | Optional |\n| request_type | String | Body | Array including the type of export being generated. Options include 'tile' and 'zip'. At least one must be specified. _Note: specifying tile type adds more required and optional parameters to the request. For example, `\"request_type\": [ \"tile\", \"zip\" ]` | Required |\n| s3_bucket | String | Body | The S3 bucket to which tiles will be written. If not provided, then tiles will be written to the bucket configured by VectorServices. For example, `\"s3_bucket\": \"my_bucket\"` | Optional |\n| s3_prefix | String | Body | The prefix (directory path) used for the generated tiles. Tiles will be written to the path in subdirectories based on zoom level. If not provided, a UUID will be generated and used as the path. **Note**: when deciding on s3 prefix, be aware that using the same prefix repeatedly will *overwrite* previous exports. User defined s3 prefixes should be changed with every export to prevent this. For example, `\"s3_prefix\": \"my_test\"` | Optional |\n| s3_region | String | Body | The region where tiles will be written. Defaults to `us-east-1`. For example, `\"s3_region\": \"us-west-1\"` | Optional |\n| tile_params | String | Body | Additional tile definitions when `request_type` includes `tile`. See [Tile Param Sub-Part Parameters](doc:vector-tile-generation-export-reference-overview#section-tile-param-sub-part-parameters) | Optional |\n\n\n##Tile Param Sub-Part Parameters##\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| layer_name | String | Body | The layer name for the features in the tileset. For example, `\"layer_name\": \"Vancouver Building Footprints\"` | Required when generating tiles |\n| tileset_description | String | Body | The description for the tileset. If not provided, the tileset name will be used. For example, `\"tileset_description\": \"A test tileset.\"` | Optional; not used when generating zips |\n| tileset_name | String | Body | The name of the tileset. For example, `\"tileset_name\": \"Testuser Vancouver Set\"` | Required when generating tiles |\n| max_zoom | Integer | Body | The maximum zoom level to be generated, Defaults to an estimated guess based on vector feature spacing. _Note: Maximum is restricted to zoom level 15 through the API. For zoom levels 16-20, manual request must be made to InsightCloud-Dev:::at:::digitalglobe.com._ For example, `\"max_zoom\": 13` | Optional |\n| min_zoom | Integer | Body | The minimum zoom level to be generated. Defaults to 0. For example, `\"min_zoom\": 5` | Optional |\n| simplification | Integer | Body | The simplification factor to use for tiles. The lowest zoom level is not simplified. Defaults to 10. **Note**: the highest zoom level is never simplified. For example, `\"simplification\": 8` | Optional |\n\nAll tile_param parameters put together would look something like:\n\n```\n\"tile_params\": {\n\t\t\"tileset_name\": \"DC Set\",\n\t\t\"layer_name\": \"DC Building Footprints\",\n\t\t\"tileset_description\": \"Test set of DC buiding footprints.\",\n\t\t\"min_zoom\": 5,\n\t\t\"max_zoom\": 13,\n\t\t\"simplification\": 8\n\t}\n```\n\n##Callback Sub-Part Parameters##\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| headers | String | Body | Any headers that should be supplied with the request. For example, `\"headers\": { \"Authorization\": \"my token\" }` | Optional |\n| params | String | Body | Any query parameters that should be supplied with the request. For example, `\"params\": { \"key\": \"value\" }` | Optional |\n| url | String | Body | The URL to which start/finish messages will be sent. For example, `\"url\": \"http://my.url.app/receiver\"` | Optional |\n\nAll callback parameters put together would look something like:\n\n```\n\"callbacks\": [\n    {\n      \"url\": \"http://my.url.app/receiver\",\n      \"headers\": {\n        \"Authorization\": \"my credentials\"\n      },\n      \"params\": {\n        \"my_param\": \"my_value\"\n      }\n    }\n]\n```\n\n\nSee [Vector Export Service Example Constructions](doc:vector-export-service-example-constructions) for various use case examples of vector exports.\n\n#Associated API Calls for Tilegen Export#\n[Export Tile Generation](doc:export-vectors)\n[View Export Status](doc:view-export-status)","excerpt":"Overview of the Tile Generation Vectors API","slug":"vector-export-service-reference-overview","type":"basic","title":"Vector Export Service Reference Overview"}

Vector Export Service Reference Overview

Overview of the Tile Generation Vectors API

| Table of Contents | | --- | | [TileGen Export API Parameters](#section-api-parameters) | | [Associated API Calls for TileGen Export](#section-associated-api-calls-for-tilegen-export) | These endpoints work in any application. #API Parameters# | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | callback | String | Body | Callback definition for receiving start/status notifications. If configured, a callback is sent when the tile generation process begins and again when it ends. See [View Export Status](doc:view-export-status) for a description of the information sent in those requests. A URL must be provided for the callback, and optionally, additional header and query parameter information can be configured to be sent with the callback (e.g. for authenticating with the callback receiver). See [Callback Sub-Part Parameters](doc:vector-tile-generation-export-reference-overview#section-tile-param-sub-part-parameters) | Optional | | geometry | String | Body | Specifies the area to use in selecting features from Elasticsearch. Only features inside the provided geometry will be included. If not provided, then all documents from the index specified in the 'index' field will be returned. For example, `"geometry": { "type": "GeometryCollection", "geometries": [ { "type": "Polygon", "coordinates": [[[1.7,1.9], [1.7,2.5],[2.5,2.5],[2.5,1.9],[1.7,1.9]]] }` | Optional | | index | String | Body | The Elasticsearch index/alias pattern to use when querying data. For example, `"index": "vector-gbdx-alphla-catalog-v2*"` | Required | | query | String | Body | An Elasticsearch query used to refine the query. If this field is a string value, it's treated as an ES query_string query. If it's a JSON object, it's interpreted as an Elasticsearch query object. See the Elasticsearch query DSL documentation for more details. If the query is not provided, then all documents from the index specified in the 'index' field will be returned. For example, `"query": { "query_string": { "query": "item_type: SENTINEL2" } }` | Optional | | request_type | String | Body | Array including the type of export being generated. Options include 'tile' and 'zip'. At least one must be specified. _Note: specifying tile type adds more required and optional parameters to the request. For example, `"request_type": [ "tile", "zip" ]` | Required | | s3_bucket | String | Body | The S3 bucket to which tiles will be written. If not provided, then tiles will be written to the bucket configured by VectorServices. For example, `"s3_bucket": "my_bucket"` | Optional | | s3_prefix | String | Body | The prefix (directory path) used for the generated tiles. Tiles will be written to the path in subdirectories based on zoom level. If not provided, a UUID will be generated and used as the path. **Note**: when deciding on s3 prefix, be aware that using the same prefix repeatedly will *overwrite* previous exports. User defined s3 prefixes should be changed with every export to prevent this. For example, `"s3_prefix": "my_test"` | Optional | | s3_region | String | Body | The region where tiles will be written. Defaults to `us-east-1`. For example, `"s3_region": "us-west-1"` | Optional | | tile_params | String | Body | Additional tile definitions when `request_type` includes `tile`. See [Tile Param Sub-Part Parameters](doc:vector-tile-generation-export-reference-overview#section-tile-param-sub-part-parameters) | Optional | ##Tile Param Sub-Part Parameters## | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | layer_name | String | Body | The layer name for the features in the tileset. For example, `"layer_name": "Vancouver Building Footprints"` | Required when generating tiles | | tileset_description | String | Body | The description for the tileset. If not provided, the tileset name will be used. For example, `"tileset_description": "A test tileset."` | Optional; not used when generating zips | | tileset_name | String | Body | The name of the tileset. For example, `"tileset_name": "Testuser Vancouver Set"` | Required when generating tiles | | max_zoom | Integer | Body | The maximum zoom level to be generated, Defaults to an estimated guess based on vector feature spacing. _Note: Maximum is restricted to zoom level 15 through the API. For zoom levels 16-20, manual request must be made to InsightCloud-Dev@digitalglobe.com._ For example, `"max_zoom": 13` | Optional | | min_zoom | Integer | Body | The minimum zoom level to be generated. Defaults to 0. For example, `"min_zoom": 5` | Optional | | simplification | Integer | Body | The simplification factor to use for tiles. The lowest zoom level is not simplified. Defaults to 10. **Note**: the highest zoom level is never simplified. For example, `"simplification": 8` | Optional | All tile_param parameters put together would look something like: ``` "tile_params": { "tileset_name": "DC Set", "layer_name": "DC Building Footprints", "tileset_description": "Test set of DC buiding footprints.", "min_zoom": 5, "max_zoom": 13, "simplification": 8 } ``` ##Callback Sub-Part Parameters## | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | headers | String | Body | Any headers that should be supplied with the request. For example, `"headers": { "Authorization": "my token" }` | Optional | | params | String | Body | Any query parameters that should be supplied with the request. For example, `"params": { "key": "value" }` | Optional | | url | String | Body | The URL to which start/finish messages will be sent. For example, `"url": "http://my.url.app/receiver"` | Optional | All callback parameters put together would look something like: ``` "callbacks": [ { "url": "http://my.url.app/receiver", "headers": { "Authorization": "my credentials" }, "params": { "my_param": "my_value" } } ] ``` See [Vector Export Service Example Constructions](doc:vector-export-service-example-constructions) for various use case examples of vector exports. #Associated API Calls for Tilegen Export# [Export Tile Generation](doc:export-vectors) [View Export Status](doc:view-export-status)