Analyses of a specific Plot
List all analyses of the specified plot.
GET /plots/{plotId}/analyses HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Accept: */*
[
{
"id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
"createdAt": "2023-07-26T15:03:48Z",
"updatedAt": "2023-07-28T09:13:37Z",
"status": "started",
"plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
"analysedAt": "2023-07-28T09:13:37Z",
"version": "open-source-1.0.0",
"deforestedArea": 123.45,
"deforestedGeometry": {
"type": "Polygon",
"coordinates": [
[
[
13,
52.5
],
[
13.5,
52.5
],
[
13.5,
52
],
[
13,
52
],
[
13,
52.5
]
]
]
},
"riskOfDeforestation": 0.3,
"type": "EUFOROBS",
"customData": {
"some": "metadata"
},
"name": "text"
}
]
Requests an analysis for the specified plot. The analysis happens asynchronously, so you will receive a response object which includes a 'status' and an 'id' immediately after calling this endpoint. The status will be updated by the system once the actual analysis is completed.
Human-friendly name of the analysis for reference
Some name for the analysis
Type of analysis to be performed. Currently only EUFOROBS and PRECISION are supported.
EUFOROBS
Custom data related to the analysis. This can be used to store any additional information that is relevant to the analysis. The input object must fulfill the following requirements: - max <=10 keys - max key length of <=255 characters - max string value length of <=255 characters - values must be either strings, number, or booleans - keys cannot contain the substrings proto, constructor, or prototype
{"key1":"someValue","key2":true,"key3":1234}
Alias for customData. See customData for requirements. This field is deprecated and will be removed in the future. Please use customData instead.
{"key1":"someValue","key2":true,"key3":1234}
501 Not Implemented when the analysis type is not implemented yet.
503 Service Unavailable when the analyses service is not available.
POST /plots/{plotId}/analyses HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 113
{
"name": "Some name for the analysis",
"type": "EUFOROBS",
"customData": {
"key1": "someValue",
"key2": true,
"key3": 1234
}
}
{
"id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
"createdAt": "2023-07-26T15:03:48Z",
"updatedAt": "2023-07-28T09:13:37Z",
"status": "started",
"plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
"analysedAt": "2023-07-28T09:13:37Z",
"version": "open-source-1.0.0",
"deforestedArea": 123.45,
"deforestedGeometry": {
"type": "Polygon",
"coordinates": [
[
[
13,
52.5
],
[
13.5,
52.5
],
[
13.5,
52
],
[
13,
52
],
[
13,
52.5
]
]
]
},
"riskOfDeforestation": 0.3,
"type": "EUFOROBS",
"customData": {
"some": "metadata"
},
"name": "text"
}
Last updated