{"__v":14,"_id":"567c4421221af70d00fc53e1","category":{"__v":2,"_id":"5661fdcb55e4450d00e62c76","pages":["5661fdcd55e4450d00e62c89","5661fdcd55e4450d00e62c8a","5661fdcd55e4450d00e62c8b","567c4421221af70d00fc53e1"],"project":"5511df3be2990b0d00fb071d","version":"5661fdca55e4450d00e62c73","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-24T22:19:38.305Z","from_sync":false,"order":2,"slug":"metadata","title":"Products"},"parentDoc":null,"project":"5511df3be2990b0d00fb071d","user":"5511dee39171e82b00897349","version":{"__v":2,"_id":"5661fdca55e4450d00e62c73","project":"5511df3be2990b0d00fb071d","createdAt":"2015-12-04T20:55:38.639Z","releaseDate":"2015-12-04T20:55:38.639Z","categories":["5661fdcb55e4450d00e62c74","5661fdcb55e4450d00e62c75","5661fdcb55e4450d00e62c76","5661fdcb55e4450d00e62c77","5661fdcb55e4450d00e62c78","5661fdcb55e4450d00e62c79","567c42b13241c20d00b7312e"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-24T19:14:41.972Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl https://api.astrodigital.com/v2.0/products","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"count\": 6,\n  \"next\": null,\n  \"previous\": null,\n  \"results\": [\n    {\n      \"id\": 1,\n      \"description\": \"A visually appealing approximation of the image's natural appearance.\",\n      \"name\": \"True Color Image\",\n      \"product\": \"true_color\",\n      \"actions\": [\n        \"mapbox\",\n        \"raw\",\n        \"processed\"\n      ]\n    },\n    {\n      \"id\": 2,\n      \"description\": \"Visualize the health of vegetation; the densest vegetation is shown in orange.\",\n      \"name\": \"NDVI\",\n      \"product\": \"ndvi_image\",\n      \"actions\": [\n        \"mapbox\",\n        \"raw\",\n        \"processed\"\n      ]\n    },\n    {\n      \"id\": 3,\n      \"description\": \"Monitor city growth; blues and grays show urban areas.\",\n      \"name\": \"Urban False Color\",\n      \"product\": \"urban_false\",\n      \"actions\": [\n        \"mapbox\",\n        \"raw\",\n        \"processed\"\n      ]\n    },\n    {\n      \"id\": 4,\n      \"description\": \"Uses the near infrared band to easily identify shorelines.\",\n      \"name\": \"Land/Water Boundary\",\n      \"product\": \"land_water\",\n      \"actions\": [\n        \"mapbox\",\n        \"raw\",\n        \"processed\"\n      ]\n    },\n    {\n      \"id\": 5,\n      \"description\": \"Retrieve an averaged NDVI value for your AOIs.\",\n      \"name\": \"Vegetation Trend\",\n      \"product\": \"ndvi_value\",\n      \"actions\": [\n        \"values\"\n      ]\n    },\n    {\n      \"id\": 6,\n      \"description\": \"Search our full imagery catalog for matches and receive metadata.\",\n      \"name\": \"Get Metadata\",\n      \"product\": \"metadata\",\n      \"actions\": [\n        \"raw\"\n      ]\n    }\n  ]\n}","name":""}]},"settings":"56a8d993c0e02f0d007fa916","auth":"required","params":[],"url":"/products"},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Products List\"\n}\n[/block]\nThe `products` endpoint provides a list of analysis products that can be produced by a [Task](doc:overview) and the actions that can be used to generate [Results](doc:overview). Not all Products have the same Results available to them and you will receive an error if you try and use an invalid action. Products as well as actions are described in more detail in the charts below.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Product Name\",\n    \"h-1\": \"Product ID\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"True Color Image\",\n    \"0-1\": \"true_color\",\n    \"1-0\": \"NDVI\",\n    \"1-1\": \"ndvi_image\",\n    \"2-0\": \"Urban False Image\",\n    \"2-1\": \"urban_false\",\n    \"3-0\": \"Land/Water Boundary\",\n    \"3-1\": \"land_water\",\n    \"4-0\": \"Vegetation Trends\",\n    \"4-1\": \"ndvi_value\",\n    \"5-0\": \"Get Metadata\",\n    \"5-1\": \"metadata\",\n    \"0-2\": \"A visually appealing approximation of the image's natural appearance.\",\n    \"1-2\": \"Visualize the health of vegetation; the densest vegetation is shown in orange.\",\n    \"2-2\": \"Monitor city growth; blues and grays show urban areas.\",\n    \"3-2\": \"Uses the near infrared band to easily identify shorelines.\",\n    \"4-2\": \"Retrieve an averaged NDVI value for your AOIs. For this to be a valid option, all polygons within your AOI must be between 0.3km<sup>2</sup> and 30km<sup>2</sup>. Methodology of averaged NDVI  calculation is described [here](https://gist.github.com/akudrya/2802a9471e7fe86e5ea1ab937a19394e)\",\n    \"5-2\": \"Search our full imagery catalog for matches and receive metadata.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Colormaps\"\n}\n[/block]\nEach imagery product is shown in a certain RGB colormap. For True Color, Urban False and Land/Water Boundary the colormap is generating by merging corresponding spectral bands into red, green and blue channels of the output image. Such approach allows Astro Digital True Color product's output image be a combination of Red, Green and Blue channels. \n\nFor NDVI imagery product an artificial colormap is used. The idea is to show non-vegetated areas in grey, low vegetation in red and high vegetation in green. Here's an image of possible colors that can be found on an Astro Digital NDVI image with corresponding NDVI values:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/xioo4NGaRRy3iu1Lg0JH_legend.png\",\n        \"legend.png\",\n        \"614\",\n        \"82\",\n        \"#e52a04\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Actions List\"\n}\n[/block]\nWith the product generated by Astro Digital platform you can perform the following actions:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Action Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"mapbox\",\n    \"1-0\": \"raw\",\n    \"2-0\": \"processed\",\n    \"0-1\": \"Have your processed result published to Mapbox as a web-accessible map.\",\n    \"1-1\": \"Get a link to the raw, unprocessed image used to generate the processed result. *Format depends on imagery source*\",\n    \"2-1\": \"Get a link to the processed, cropped (if you provided an AOI) image. *Format is an 8-bit GeoTIFF*\",\n    \"3-0\": \"values\",\n    \"3-1\": \"Receive data values (as in the case of NDVI Values). *Format depends on data source*\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","excerpt":"View of list of available analysis products","slug":"products","type":"endpoint","title":"/products"}

get/products

View of list of available analysis products

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Products List" } [/block] The `products` endpoint provides a list of analysis products that can be produced by a [Task](doc:overview) and the actions that can be used to generate [Results](doc:overview). Not all Products have the same Results available to them and you will receive an error if you try and use an invalid action. Products as well as actions are described in more detail in the charts below. [block:parameters] { "data": { "h-0": "Product Name", "h-1": "Product ID", "h-2": "Description", "0-0": "True Color Image", "0-1": "true_color", "1-0": "NDVI", "1-1": "ndvi_image", "2-0": "Urban False Image", "2-1": "urban_false", "3-0": "Land/Water Boundary", "3-1": "land_water", "4-0": "Vegetation Trends", "4-1": "ndvi_value", "5-0": "Get Metadata", "5-1": "metadata", "0-2": "A visually appealing approximation of the image's natural appearance.", "1-2": "Visualize the health of vegetation; the densest vegetation is shown in orange.", "2-2": "Monitor city growth; blues and grays show urban areas.", "3-2": "Uses the near infrared band to easily identify shorelines.", "4-2": "Retrieve an averaged NDVI value for your AOIs. For this to be a valid option, all polygons within your AOI must be between 0.3km<sup>2</sup> and 30km<sup>2</sup>. Methodology of averaged NDVI calculation is described [here](https://gist.github.com/akudrya/2802a9471e7fe86e5ea1ab937a19394e)", "5-2": "Search our full imagery catalog for matches and receive metadata." }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Colormaps" } [/block] Each imagery product is shown in a certain RGB colormap. For True Color, Urban False and Land/Water Boundary the colormap is generating by merging corresponding spectral bands into red, green and blue channels of the output image. Such approach allows Astro Digital True Color product's output image be a combination of Red, Green and Blue channels. For NDVI imagery product an artificial colormap is used. The idea is to show non-vegetated areas in grey, low vegetation in red and high vegetation in green. Here's an image of possible colors that can be found on an Astro Digital NDVI image with corresponding NDVI values: [block:image] { "images": [ { "image": [ "https://files.readme.io/xioo4NGaRRy3iu1Lg0JH_legend.png", "legend.png", "614", "82", "#e52a04", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Actions List" } [/block] With the product generated by Astro Digital platform you can perform the following actions: [block:parameters] { "data": { "h-0": "Action Name", "h-1": "Description", "h-2": "Description", "0-0": "mapbox", "1-0": "raw", "2-0": "processed", "0-1": "Have your processed result published to Mapbox as a web-accessible map.", "1-1": "Get a link to the raw, unprocessed image used to generate the processed result. *Format depends on imagery source*", "2-1": "Get a link to the processed, cropped (if you provided an AOI) image. *Format is an 8-bit GeoTIFF*", "3-0": "values", "3-1": "Receive data values (as in the case of NDVI Values). *Format depends on data source*" }, "cols": 2, "rows": 4 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}