{"_id":"567c4af88eb5b20d00210559","version":{"_id":"5661fdca55e4450d00e62c73","project":"5511df3be2990b0d00fb071d","__v":2,"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"},"__v":7,"category":{"_id":"5661fdcb55e4450d00e62c79","version":"5661fdca55e4450d00e62c73","__v":8,"pages":["5661fdcc55e4450d00e62c80","5661fdcc55e4450d00e62c81","5661fdcc55e4450d00e62c82","5661fdcc55e4450d00e62c83","5661fdcc55e4450d00e62c84","5661fdcc55e4450d00e62c85","5661fdcc55e4450d00e62c86","5661fdcc55e4450d00e62c87","5661fdcc55e4450d00e62c88","567c46a37c40060d005604c1","567c479a8eb5b20d00210557","567c4829815f250d0094adbb","567c48a3815f250d0094adbd","567c496b7c40060d005604c5","567c4af88eb5b20d00210559","567c4cb9abbcf90d00ca50c2"],"project":"5511df3be2990b0d00fb071d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-27T12:30:20.218Z","from_sync":false,"order":1,"slug":"alerts-notifications","title":"Tasks & Results"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"5511df3be2990b0d00fb071d","user":"5511dee39171e82b00897349","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-24T19:43:52.540Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"count\":2,\n    \"next\":null,\n    \"previous\":null,\n    \"results\":[\n        {\n            \"id\":19,\n            \"created_at\":\"2016-01-29T18:59:52.090109Z\",\n            \"value\":{\n                \"map_id\":\"astrodigital.56abb16f4959330006010a83\",\n                \"raw_image_url\":\"http://storage.googleapis.com/earthengine-public/landsat/L8/099/066/LC80990662016021LGN00.tar.bz\"\n            },\n            \"product\": \"true_color\",\n            \"status\":\"COMPLETED\",\n            \"status_time\":\"2016-01-29T18:59:52.101871Z\",\n            \"secondary_status\":null,\n            \"is_failed\":false,\n            \"fail_reason\":null,\n            \"fail_time\":null,\n            \"is_ready\":true,\n            \"task\":42\n        },\n        {\n            \"id\":17,\n            \"created_at\":\"2016-01-29T18:47:02.932512Z\",\n            \"value\":{\n                \"raw_image_url\":\"http://storage.googleapis.com/earthengine-public/landsat/L8/099/066/LC80990662016021LGN00.tar.bz\"\n            },\n            \"product\": \"urban_false\",\n            \"status\":\"COMPLETED\",\n            \"status_time\":\"2016-01-29T18:51:08.801238Z\",\n            \"secondary_status\":null,\n            \"is_failed\":false,\n            \"fail_reason\":null,\n            \"fail_time\":null,\n            \"is_ready\":true,\n            \"task\":40\n        }\n    ]\n}","name":""}]},"settings":"56a8d993c0e02f0d007fa916","examples":{"codes":[{"language":"curl","code":"curl https://api.astrodigital.com/v2.0/results?is_ready=true&product=true_color -H 'Authorization: Token YOUR_TOKEN'"}]},"method":"get","auth":"required","params":[{"_id":"567c4af88eb5b20d0021055f","ref":"","in":"query","required":false,"desc":"Filter Results by Product. (e.g. `true_color`, `urban_false`), see the full list of [/products](doc:products)","default":"","type":"string","name":"product"},{"_id":"567c4af88eb5b20d0021055c","ref":"","in":"query","required":false,"desc":"Filter by status. `INPROGRESS`, `COMPLETED`, `FAILED`","default":"","type":"string","name":"status"},{"_id":"567c4af88eb5b20d0021055b","ref":"","in":"query","required":false,"desc":"Filter by valid Task ID","default":"","type":"int","name":"task_id"},{"_id":"56abb90a9327b30d00f7c237","ref":"","in":"query","required":false,"desc":"Filter by failure status.","default":"","type":"boolean","name":"is_failed"},{"_id":"56abb90a9327b30d00f7c236","ref":"","in":"query","required":false,"desc":"Filter by ready status.","default":"","type":"boolean","name":"is_ready"},{"_id":"574649f77af791170073ca7d","ref":"","in":"query","required":false,"desc":"Number of items in the API response. Limit is 10,000 items per page","default":"100","type":"int","name":"page_size"},{"_id":"580823b50576b40f000a5d54","ref":"","in":"query","required":false,"desc":"Earliest date of the updated result","default":"","type":"yyyy-mm-dd","name":"updated_from"},{"_id":"5808237580074f0f00fc3c6f","ref":"","in":"query","required":false,"desc":"Latest date of the updated result","default":"","type":"yyyy-mm-dd","name":"updated_to"},{"_id":"59603600504204001bc5e64b","ref":"","in":"header","required":false,"desc":"Instead of *** please use account from the Mission Control (fetch.astrodigital.com)","default":"Token ***","type":"string","name":"Authorization"}],"url":"/results"},"isReference":false,"order":5,"body":"Get a list of results, filtered by optional parameters. Results are the output of your [Tasks](doc:overview) and contain any information associated with the product. An overview of Result properties can be found in the table below.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"created_at\",\n    \"2-0\": \"value\",\n    \"3-0\": \"product\",\n    \"4-0\": \"status\",\n    \"5-0\": \"secondary_status\",\n    \"6-0\": \"status_time\",\n    \"7-0\": \"is_ready\",\n    \"8-0\": \"is_failed\",\n    \"9-0\": \"fail_time\",\n    \"10-0\": \"fail_reason\",\n    \"11-0\": \"task\",\n    \"0-1\": \"Unique system identifier for this Result.\",\n    \"1-1\": \"The time (ISO8601) that the Result was created at.\",\n    \"2-1\": \"A JSON object containing the result of the Task, this will differ depending on the actions that were associated with the Task. More information below.\",\n    \"3-1\": \"The Product that is associated with the Result.\",\n    \"4-1\": \"Status of the Result, `INPROGRESS`, `COMPLETED` or `FAILED`.\",\n    \"5-1\": \"Secondary status with descriptive information that can be used along with primary status.\",\n    \"6-1\": \"The time at which the status was updated.\",\n    \"7-1\": \"Is the Result ready?\",\n    \"8-1\": \"Has the Result failed?\",\n    \"9-1\": \"The time at which the Result failed.\",\n    \"10-1\": \"Information regarding why the Result failed to be generated.\",\n    \"11-1\": \"The parent Task that this Result belongs to.\",\n    \"12-0\": \"aoi_coverage_percentage\",\n    \"12-1\": \"How much of the aoi is covered with a scene\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Tell me more about the `value` field!\",\n  \"body\": \"We're glad you asked! The `value` field is where the actual information you're after is stored. It's a JSON object that contains an item for each action you asked to be taken on your imagery. So if you asked to have imagery processed as True Color and have it published as a webmap, receive a link to the processed imagery and the raw imagery, you will see a `value` object with three separate fields in it.\"\n}\n[/block]","excerpt":"","slug":"results","type":"endpoint","title":"/results"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

product:
string
Filter Results by Product. (e.g. `true_color`, `urban_false`), see the full list of [/products](doc:products)
status:
string
Filter by status. `INPROGRESS`, `COMPLETED`, `FAILED`
task_id:
integer
Filter by valid Task ID
is_failed:
boolean
Filter by failure status.
is_ready:
boolean
Filter by ready status.
page_size:
integer100
Number of items in the API response. Limit is 10,000 items per page
updated_from:
yyyy-mm-dd
Earliest date of the updated result
updated_to:
yyyy-mm-dd
Latest date of the updated result

Headers

Authorization:
stringToken ***
Instead of *** please use account from the Mission Control (fetch.astrodigital.com)

Examples


Result Format


Documentation

Get a list of results, filtered by optional parameters. Results are the output of your [Tasks](doc:overview) and contain any information associated with the product. An overview of Result properties can be found in the table below. [block:parameters] { "data": { "h-0": "Parameter name", "h-1": "Description", "0-0": "id", "1-0": "created_at", "2-0": "value", "3-0": "product", "4-0": "status", "5-0": "secondary_status", "6-0": "status_time", "7-0": "is_ready", "8-0": "is_failed", "9-0": "fail_time", "10-0": "fail_reason", "11-0": "task", "0-1": "Unique system identifier for this Result.", "1-1": "The time (ISO8601) that the Result was created at.", "2-1": "A JSON object containing the result of the Task, this will differ depending on the actions that were associated with the Task. More information below.", "3-1": "The Product that is associated with the Result.", "4-1": "Status of the Result, `INPROGRESS`, `COMPLETED` or `FAILED`.", "5-1": "Secondary status with descriptive information that can be used along with primary status.", "6-1": "The time at which the status was updated.", "7-1": "Is the Result ready?", "8-1": "Has the Result failed?", "9-1": "The time at which the Result failed.", "10-1": "Information regarding why the Result failed to be generated.", "11-1": "The parent Task that this Result belongs to.", "12-0": "aoi_coverage_percentage", "12-1": "How much of the aoi is covered with a scene" }, "cols": 2, "rows": 13 } [/block] [block:callout] { "type": "info", "title": "Tell me more about the `value` field!", "body": "We're glad you asked! The `value` field is where the actual information you're after is stored. It's a JSON object that contains an item for each action you asked to be taken on your imagery. So if you asked to have imagery processed as True Color and have it published as a webmap, receive a link to the processed imagery and the raw imagery, you will see a `value` object with three separate fields in it." } [/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 }}