Analyses of a specific Plot

List all EUFOROBS and PRECISION analyses of plot.

get

List all EUFOROBS and PRECISION analyses of the specified plot.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

plotIdstringRequired

Responses

200Success

application/json

idstringRequired

Id of this analysis

Example: 02c36247-1aad-41ba-aa49-f114ca4c263f

createdAtstringRequired

ISO 8601

Example: 2023-07-26T15:03:48Z

updatedAtstringRequired

ISO 8601

Example: 2023-07-28T09:13:37Z

statusall ofRequired

The overall status of the underlying analysis pipeline

Example: PENDING

string · enumOptional

The overall status of the underlying analysis pipeline

Possible values:

plotIdstringRequired

Id of the plot that this analysis belongs to and is performed on

Example: 02c36247-1aad-41ba-aa49-f114ca4c263f

analysedAtstringOptional

ISO 8601

Example: 2023-07-28T09:13:37Z

versionstringOptional

The version of the analysis pipeline that was run

Example: open-source-1.0.0

deforestedAreanumberOptional

The deforested area in square meters

Example: 123.45

deforestedGeometryone ofOptional

The deforested area as a GeoJSON Polygon

Example: {"type":"Polygon","coordinates":[[[13,52.5],[13.5,52.5],[13.5,52],[13,52],[13,52.5]]]}

or

riskOfDeforestationnumberOptional

The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation.

Example: 0.3

typeall ofRequired

The type of analysis that was requested

Example: OS

string · enumOptional

The type of analysis that was requested

Possible values:

customDataobjectOptional

Additional custom data. We don't use it for any calculations.

Example: {"some":"metadata"}

metadataobjectOptionalDeprecated

Additional metadata. We don't use it for any calculations. This field is deprecated and will be removed in the future. Please use customData instead.

Example: {"some":"metadata"}

namestringOptional

A human-friendly name for this analysis

401Error

403

User does not have access to this plot

404Error

get

/plots/{plotId}/analyses

HTTPcURLJavaScriptPython

GET /plots/{plotId}/analyses HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "status": "PENDING",
    "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": "OS",
    "customData": {
      "some": "metadata"
    },
    "name": "text"
  }
]

Create an analysis for plot.

post

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.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

plotIdstringRequired

Body

application/json

namestringOptional

Human-friendly name of the analysis for reference

Example: Some name for the analysis

typeall ofRequired

Type of analysis to be performed. Currently only EUFOROBS, PRECISION and OS are supported.

Example: EUFOROBS

string · enumOptional

The type of analysis that was requested

Possible values:

customDataobjectOptional

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

Example: {"key1":"someValue","key2":true,"key3":1234}

metadataobjectOptionalDeprecated

Alias for customData. See customData for requirements. This field is deprecated and will be removed in the future. Please use customData instead.

Example: {"key1":"someValue","key2":true,"key3":1234}

Responses

201Success

application/json

400Error

401Error

403Error

404Error

501

501 Not Implemented when the analysis type is not implemented yet.

503

503 Service Unavailable when the analyses service is not available.

post

/plots/{plotId}/analyses

HTTPcURLJavaScriptPython

POST /plots/{plotId}/analyses HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
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": "PENDING",
  "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": "OS",
  "customData": {
    "some": "metadata"
  },
  "name": "text"
}