TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Risk Assessment
    • Transaction Management
    • Document Management
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Plot Uploading and Analysis Requests
    • Commercial network management
    • Transaction Management
    • API reference
      • Auth
      • Plots
        • Analyses of a specific Plot
        • Batch
      • Analyses
      • Attachments
      • Business invitations
      • Business connections
      • Transactions
        • Create a Transaction
        • Retrieve Transactions
          • Get a transaction by id
          • List all transactions
        • Modify an existing Transaction
          • Update a Transaction
          • Add a Transaction Component
          • Update a Transaction Component
          • Delete a Transaction Component
        • Delete a Transaction
        • Submit a Transaction
        • Retrieve DDS Data
      • Risk Assessments
        • Supplier Risk Assessments
          • Create a Supplier Risk Assessment
          • Update a Supplier Risk Assessment
          • Retrieve Supplier Risk Assessments
            • Get a supplier risk assessment by id
            • Get all supplier risk assessments
          • Retrieve the history
        • Plot Risk Assessments
          • Create a Plot Risk Assessment
          • Update a Plot Risk Assessment
          • Retrieve Plot Risk Assessments
            • Get a plot risk assessment by id
            • Get all plot risk assessments
          • Retrieve the history
      • Survey responses
      • Health
      • Version
      • Specification
  • Additional Resources
    • FAQs
    • Contact Support
    • Terms and Conditions
Powered by GitBook
On this page
  1. Using the TradeAware API
  2. API reference

Analyses

PreviousBatchNextAttachments

Last updated 9 months ago

Retrieve an analysis.

get

Retrieve the specified analysis.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
401Error
403Error
404Error
get
GET /analyses/{id} 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",
  "metadata": {
    "some": "metadata"
  },
  "name": "text"
}