{"_id":"58aee19d2470660f00b544c3","parentDoc":null,"user":"56267741db1eda0d001c3dbb","__v":0,"project":"55faeacad0e22017005b8265","category":{"_id":"56e1c96b2506700e00de6e83","version":"55faeacad0e22017005b8268","__v":38,"pages":["56e1ca17cd6a8d0e00d12163","56e1cb0fe416450e00b9e485","56e1cba3cd6a8d0e00d1216c","56e1cc1ae63f910e00e5986b","56e1d0b0cd6a8d0e00d1217f","56e1d15ce416450e00b9e4a3","56e1d23292bf640e00b55663","56e1d296bc46be0e002af287","56e1d305cd6a8d0e00d1218c","56e1d373e416450e00b9e4ab","56e1d38a92bf640e00b55669","56e1d44dbc46be0e002af28e","56e2cb174cd67e220032d655","56e2cf9c1067950e006a16c8","56e2d5ff3987d729008695a0","56e2ddea8ffe6020004c53b2","56e2df768ffe6020004c53bd","56e2e1201067950e006a16f1","56e2e3888ffe6020004c53c5","56e2e53f1067950e006a1702","56e2e9773987d729008695cf","56e2ec731bffb72b00d0562e","56e2ed25b9c88f2900864aab","56e2f0314cd67e220032d6b9","56e2f3c43987d729008695ed","56e2fc3fb9c88f2900864ad7","56e2fe0d3987d7290086960b","56e30180f1ad030e00e72fa7","56e302c228f99e2000a5ffa6","56e3040c6e602e0e00700af6","56e304c5d46bc30e007bb958","56e30650d46bc30e007bb965","56e307456e602e0e00700b08","56e3086251857d0e008e778d","56e3096251857d0e008e7796","56e30a16d46bc30e007bb973","56e30aafd46bc30e007bb97c","56e30aeb51857d0e008e779f"],"project":"55faeacad0e22017005b8265","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-10T19:22:19.658Z","from_sync":false,"order":15,"slug":"read-query-vector-services-guide","title":"Read & Query Vector Services Guide"},"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-23T13:20:29.371Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":44,"body":"| Table of Contents |\n| --- |\n| [Index Query Vector Services API Parameters](#section-api-parameters) |\n| [Index Query Vector Services Parameter Limits](#section-parameter-limits) |\n| [Associated API Calls for Index Query Vector Services](#section-associated-api-calls-for-index-query-vector-services) |\n\nThese endpoints work in any application.\n\n#API Parameters#\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- |\n| aggs | String | Query | The aggregation definitions (see [Vector Services Aggregations API](doc:vector-services-aggregations-reference-overview#section-aggregations-type-definitions) for details). | Required; aggregations only  |\n| count  | Integer | Query | Definition for index query: The number of records to return per shard per page request. Definition for index aggregation: The number of groupings to return per aggregation, used to display the top N buckets for an aggregation. Default 10. | Optional |\n| endDate | String | Query | A convenience parameter for setting the value for the latest item_date value to be included in the set of aggregated items.  Note: The date range can be specified with ISO-8601 date strings or with expressions using the term \"now\" to indicate the current date. The date expressions can include simple \"date math\" by appending \"+\" or \"-\" along with a numeral and a unit. For example, to set the start date to one day ago, the start date expression would read \"now-1d\". The units supported are \"y\" (year), \"M\" (month), \"w\" (week), \"d\" (day), \"h\" (hour), \"m\" (minute), and \"s\" (second). The date range is inclusive at both ends. If no date range is provided, then all items within the AOI will be included. | Optional; Required with `startDate`; aggregations only |\n| fields | String | Path | The comma-separated list of fields to return for the items. Example: `item_date,source,item_type` | Optional |\n| index | String | Path | The index to which vector items are stored. Note: All indicies follow the format `vector-{user defined index name}` or `vector-web-{geohash}`. | Required |\n| left | String | Query | The leftmost X-coordinate for the bounding box; longitude in decimal degrees of the lower left bounding box corner. | Required for bounding box calls |\n| lower | String | Query | The lowest Y-coordinate for the bounding box; latitude in decimal degrees of the lower left bounding box corner. | Required for bounding box calls |\n| pagingId | String | Form | The paging session ID for which to retrieve a page. | Optional; required for paging results |\n| q | String | Query | The Elasticsearch query string to constrain the document set. | Required; query only |\n| query | String | Query | The Elasticsearch query string to filter the source items for the aggregations.  See [Query Syntax, Fields, and Type Suffixes](doc:vector-query-syntax-query-fields-and-type-suffixes) for more detail. | Optional; aggregations only |\n| right | String | Query | The rightmost X-coordinate for the bounding box; longitude in decimal degrees of the upper right bounding box corner. | Required for bounding box calls |\n| shape | String | Query | GeoJSON of the aoi in GeometryCollection format. Example: ```{\"type\":\"GeometryCollection\",\"geometries\":[{\"type\": \"MultiPolygon\",\"coordinates\": [[[[-109.0283203125,36.98500309285596],[-109.0283203125,40.97989806962013],[-102.06298828125,40.97989806962013],[-102.06298828125,37.00255267215955],[-109.0283203125,36.98500309285596]]]]}]}``` | Required for shape calls |\n| startDate | String | Query | A convenience parameter for setting the value for the earliest item_date value to be included in the set of aggregated items.  Note: The date range can be specified with ISO-8601 date strings or with expressions using the term \"now\" to indicate the current date. The date expressions can include simple \"date math\" by appending \"+\" or \"-\" along with a numeral and a unit. For example, to set the start date to one day ago, the start date expression would read \"now-1d\". The units supported are \"y\" (year), \"M\" (month), \"w\" (week), \"d\" (day), \"h\" (hour), \"m\" (minute), and \"s\" (second). The date range is inclusive at both ends. If no date range is provided, then all items within the AOI will be included. | Optional; Required with `endDate`; aggregations only |\n| upper | String | Query | The highest Y-coordinate for the bounding box; latitude in decimal degrees of the upper right bounding box corner. | Required for bounding box calls |\n\n#Parameter Limits#\n| Parameters | Limits |\n| --- | --- |\n| fields | Possible field options are: attributes, format, geom, geom_type, id, ingest_attributes, ingest_date, ingest_source, item_date, item_type, name, original_crs, source, text. *Note: geom will always display, even if not specified.* |\n| left | Between -180 and 180 degrees inclusive. |\n| lower | Between -90 and 90 degrees inclusive. |\n|right | Between -180 and 180 degrees inclusive. |\n| upper | Between -90 and 90 degrees inclusive. |\n\n#Associated API Calls for Index Query Vector Services#\n[Index Query: Aggregation by Bounding Box](doc:index-query-aggregation-by-bounding-box) \n[Index Query: List Vector Items for Bounding Box (Returns Default Fields)](doc:index-query-list-vector-items-for-bounding-box-returns-default-fields) \n[Index Query: List Vector Items for Bounding Box (Returns Selected Fields)](doc:index-query-list-vector-items-for-bounding-box-returns-selected-fields) \n[Index Query: List Vector Items for Shape](doc:index-query-list-vector-items-for-shape) \n[Index Query: Get Paging ID for Bounding Box](doc:index-query-get-paging-id-for-bounding-box) \n[Index Query: Get Paging ID for Shape](doc:index-query-get-paging-id-for-shape)","excerpt":"Overview of the Index Query API","slug":"vector-services-index-query-reference-overview","type":"basic","title":"Vector Services Index Query Reference Overview"}

Vector Services Index Query Reference Overview

Overview of the Index Query API

| Table of Contents | | --- | | [Index Query Vector Services API Parameters](#section-api-parameters) | | [Index Query Vector Services Parameter Limits](#section-parameter-limits) | | [Associated API Calls for Index Query Vector Services](#section-associated-api-calls-for-index-query-vector-services) | These endpoints work in any application. #API Parameters# | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | | aggs | String | Query | The aggregation definitions (see [Vector Services Aggregations API](doc:vector-services-aggregations-reference-overview#section-aggregations-type-definitions) for details). | Required; aggregations only | | count | Integer | Query | Definition for index query: The number of records to return per shard per page request. Definition for index aggregation: The number of groupings to return per aggregation, used to display the top N buckets for an aggregation. Default 10. | Optional | | endDate | String | Query | A convenience parameter for setting the value for the latest item_date value to be included in the set of aggregated items. Note: The date range can be specified with ISO-8601 date strings or with expressions using the term "now" to indicate the current date. The date expressions can include simple "date math" by appending "+" or "-" along with a numeral and a unit. For example, to set the start date to one day ago, the start date expression would read "now-1d". The units supported are "y" (year), "M" (month), "w" (week), "d" (day), "h" (hour), "m" (minute), and "s" (second). The date range is inclusive at both ends. If no date range is provided, then all items within the AOI will be included. | Optional; Required with `startDate`; aggregations only | | fields | String | Path | The comma-separated list of fields to return for the items. Example: `item_date,source,item_type` | Optional | | index | String | Path | The index to which vector items are stored. Note: All indicies follow the format `vector-{user defined index name}` or `vector-web-{geohash}`. | Required | | left | String | Query | The leftmost X-coordinate for the bounding box; longitude in decimal degrees of the lower left bounding box corner. | Required for bounding box calls | | lower | String | Query | The lowest Y-coordinate for the bounding box; latitude in decimal degrees of the lower left bounding box corner. | Required for bounding box calls | | pagingId | String | Form | The paging session ID for which to retrieve a page. | Optional; required for paging results | | q | String | Query | The Elasticsearch query string to constrain the document set. | Required; query only | | query | String | Query | The Elasticsearch query string to filter the source items for the aggregations. See [Query Syntax, Fields, and Type Suffixes](doc:vector-query-syntax-query-fields-and-type-suffixes) for more detail. | Optional; aggregations only | | right | String | Query | The rightmost X-coordinate for the bounding box; longitude in decimal degrees of the upper right bounding box corner. | Required for bounding box calls | | shape | String | Query | GeoJSON of the aoi in GeometryCollection format. Example: ```{"type":"GeometryCollection","geometries":[{"type": "MultiPolygon","coordinates": [[[[-109.0283203125,36.98500309285596],[-109.0283203125,40.97989806962013],[-102.06298828125,40.97989806962013],[-102.06298828125,37.00255267215955],[-109.0283203125,36.98500309285596]]]]}]}``` | Required for shape calls | | startDate | String | Query | A convenience parameter for setting the value for the earliest item_date value to be included in the set of aggregated items. Note: The date range can be specified with ISO-8601 date strings or with expressions using the term "now" to indicate the current date. The date expressions can include simple "date math" by appending "+" or "-" along with a numeral and a unit. For example, to set the start date to one day ago, the start date expression would read "now-1d". The units supported are "y" (year), "M" (month), "w" (week), "d" (day), "h" (hour), "m" (minute), and "s" (second). The date range is inclusive at both ends. If no date range is provided, then all items within the AOI will be included. | Optional; Required with `endDate`; aggregations only | | upper | String | Query | The highest Y-coordinate for the bounding box; latitude in decimal degrees of the upper right bounding box corner. | Required for bounding box calls | #Parameter Limits# | Parameters | Limits | | --- | --- | | fields | Possible field options are: attributes, format, geom, geom_type, id, ingest_attributes, ingest_date, ingest_source, item_date, item_type, name, original_crs, source, text. *Note: geom will always display, even if not specified.* | | left | Between -180 and 180 degrees inclusive. | | lower | Between -90 and 90 degrees inclusive. | |right | Between -180 and 180 degrees inclusive. | | upper | Between -90 and 90 degrees inclusive. | #Associated API Calls for Index Query Vector Services# [Index Query: Aggregation by Bounding Box](doc:index-query-aggregation-by-bounding-box) [Index Query: List Vector Items for Bounding Box (Returns Default Fields)](doc:index-query-list-vector-items-for-bounding-box-returns-default-fields) [Index Query: List Vector Items for Bounding Box (Returns Selected Fields)](doc:index-query-list-vector-items-for-bounding-box-returns-selected-fields) [Index Query: List Vector Items for Shape](doc:index-query-list-vector-items-for-shape) [Index Query: Get Paging ID for Bounding Box](doc:index-query-get-paging-id-for-bounding-box) [Index Query: Get Paging ID for Shape](doc:index-query-get-paging-id-for-shape)