Analyses of a specific Plot

List all analyses of plot.

List all analyses of the specified plot.

GEThttps://api.tradeaware.live-eo.com/plots/{plotId}/analyses

Path parameters

plotId*string

Response

200401403404

Body

application/json

id*string

Id of this analysis

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

createdAt*string

ISO 8601

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

updatedAt*string

ISO 8601

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

status*enum

The overall status of the underlying analysis pipeline

Example: "started"

not startedstartedsucceededfailed

plotId*string

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

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

analysedAtstring

ISO 8601

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

versionstring

The version of the analysis pipeline that was run

Example: "open-source-1.0.0"

deforestedAreanumber

The deforested area in square meters

Example: 123.45

deforestedGeometryone of

The deforested area as a GeoJSON Polygon

GetPolygonDto (object)GetMultiPolygonDto (object)

riskOfDeforestationnumber

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

Example: 0.3

type*string

The type of analysis that was requested

Example: "EUFOROBS"

metadataobject

Additional metadata. We don't use it for any calculations.

namestring

A human-friendly name for this analysis

Request

JavaScriptCurlPython

const response = await fetch('https://api.tradeaware.live-eo.com/plots/{plotId}/analyses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "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",
    "metadata": {
      "some": "metadata"
    },
    "name": "text"
  }
]

Create an analysis for plot.

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.

POSThttps://api.tradeaware.live-eo.com/plots/{plotId}/analyses

Path parameters

plotId*string

Body

application/json

namestring

Human-friendly name of the analysis for reference

Example: "Some name for the analysis"

type*string

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

Example: "EUFOROBS"

metadataobject

Metadata 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

Response

201400401403404501

Body

application/json

id*string

Id of this analysis

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

createdAt*string

ISO 8601

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

updatedAt*string

ISO 8601

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

status*enum

The overall status of the underlying analysis pipeline

Example: "started"

not startedstartedsucceededfailed

plotId*string

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

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

analysedAtstring

ISO 8601

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

versionstring

The version of the analysis pipeline that was run

Example: "open-source-1.0.0"

deforestedAreanumber

The deforested area in square meters

Example: 123.45

deforestedGeometryone of

The deforested area as a GeoJSON Polygon

GetPolygonDto (object)GetMultiPolygonDto (object)

riskOfDeforestationnumber

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

Example: 0.3

type*string

The type of analysis that was requested

Example: "EUFOROBS"

metadataobject

Additional metadata. We don't use it for any calculations.

namestring

A human-friendly name for this analysis

Request

JavaScriptCurlPython

const response = await fetch('https://api.tradeaware.live-eo.com/plots/{plotId}/analyses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "EUFOROBS"
    }),
});
const data = await response.json();

Response

201

{
  "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",
  "metadata": {
    "some": "metadata"
  },
  "name": "text"
}