Analyses

Retrieve an analysis.

Retrieve the specified analysis.

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

Path parameters

id*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

deforestedGeometryall of

The deforested area as a GeoJSON Polygon

riskOfDeforestationnumber

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

Example: 0.3

metadataobject

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

name*string

A human-friendly name for this analysis

type*string

The type of analysis that was requested

Example: "EUFOROBS"

Request

JavaScriptCurlPython

const response = await fetch('https://api.tradeaware.live-eo.com/analyses/{id}', {
    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,
  "metadata": {
    "some": "metadata"
  },
  "name": "text",
  "type": "EUFOROBS"
}