CHchloris

Create or update a reporting unit.

put/reportingUnit

Request

Request body

organizationIdstring

organization ID

reportingUnitIdstring

reporting unit UUID

controlReportingUnitIdstring

control reporting unit id

tagsstring[]

The list of tags to organize this site into.

labelstring

label

descriptionstring

This is a description of a reportingUnit

resolutioninteger

The desired resolution of the outputs. Valid options are 30 and 10 (meters).

periodChangeStartYearinteger

The start of the period of interest

periodChangeEndYearinteger

The end of the period of interest (inclusive)

forestBaselineYearinteger

The year of the forest baseline (periodChangeStartYear will be used if not provided)

boundaryPathstring

boundary path

controlBoundaryPathstring

control boundary path, only valid for initial creation.

Example request

{
  "organizationId": "12341234-1234-1234-1234-123412341234",
  "reportingUnitId": "12341234-1234-1234-1234-123412341234",
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ],
  "resolution": 30,
  "periodChangeStartYear": 2000,
  "periodChangeEndYear": 2023,
  "forestBaselineYear": 2005,
  "boundaryPath": "s3://path/to/boundary",
  "controlBoundaryPath": "s3://path/to/control/boundary"
}

Response

Success

organizationIdstring

organization ID

reportingUnitIdstring

reporting unit uuid7

branchIdstring

If the entry is an aggregate branch (i.e. a tag), this is the branch ID

controlReportingUnitIdstring

The reporting unit ID of the control site

controlForReportingUnitIdstring

The reporting unit ID of the site this is a control for

tagsstring[]

A list of tags associated with the reporting unit. Acts as a key way to organize and aggregate reporting units.

labelstring

The label / name of the reporting unit.

descriptionstring

A description of the reporting unit.

createdAtstring

When the entry was created (ISO8601)

updatedAtstring

When the entry was last updated (ISO8601)

analysisSubmittedAtstring

When the entry was submitted for processing (ISO8601)

analysisCompletedAtstring

When the entry analysis was lasy updated (ISO8601)

qualityControlledAtstring

When the entry was QC approved, without this the analysis is considered preliminary and should not be used (ISO8601)

deletedAtstring

When the entry was archived (ISO8601)

refundedAtstring

When the entry's usage was refunded (ISO8601)

usersNotifiedAtstring

When the users were notified the site is ready, only happens once (ISO8601)

webhookNotifiedAtstring

When the registered webhook was notified successfully last. Can be used to recover from dropped webhook events. (ISO8601)

periodChangeStartYearinteger

The start of the period of interest

periodChangeEndYearinteger

The end of the period of interest (inclusive)

boundaryPathstring

The path to the geojson boundary for this site

hiddenboolean

Whether the entry is hidden by default in the frontend and excluded from aggregation stats. Useful for control sites.

controlReportingUnitReportingUnitEntry circular
areaKm2number

The vector area of the reporting unit in square kilometers.

analyzedAreaKm2number

The raster area of the reporting unit in square kilometers to be used when computing densities.

pointXnumber

The representative circle X (long) coord, guaranteed to intersect the boundary

pointYnumber

The representative circle Y (lat) coord, guaranteed to intersect the boundary

pointRnumber

The representative circle R coord, such that the circle fully contains the boundary

srcOrganizationIdstring

The organization ID of the source organization for this reporting unit, used only if it was copied between environments / organizations.

dataPathstring

The path to the data files for this reporting unit, used only if it was copied between environments / organizations.

periodChangeStartYearStocknumber

The stock value for the start of the period of interest

periodChangeStartYearStockErrornumber

The stock error for the start of the period of interest

periodChangeEndYearStocknumber

The stock value for the end of the period of interest

periodChangeEndYearStockErrornumber

The stock error for the end of the period of interest

periodChangenumber

The change in stock over the period of interest

periodChangeErrornumber

The error in the change in stock over the period of interest

periodChangePercentnumber

The percent change in stock over the period of interest compared to the start.

periodChangeGainnumber

The gain in stock over the period of interest

periodChangeGainErrornumber

The error in the gain in stock over the period of interest

periodChangeLossnumber

The loss in stock over the period of interest

periodChangeLossErrornumber

The error in the loss in stock over the period of interest

dryrunboolean

Whether the entry was created as a dryrun, prevents it from being processed and marks it as deletedAt 3 hours in the future.

calibratedTostring

The reporting unit ID of the site this is calibrated to.

calibratedFromstring

The reporting unit ID of the site this is calibrated from.

mangroveboolean

Whether or not the reporting unit is a mangrove site.

Example response

{
  "organizationId": "12341234-1234-1234-1234-123412341234",
  "reportingUnitId": "12341234-1234-1234-1234-123412341234",
  "branchId": "12341234-1234-1234-1234-123412341234",
  "controlReportingUnitId": "12341234-1234-1234-1234-123412341234",
  "controlForReportingUnitId": "12341234-1234-1234-1234-123412341234",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "analysisSubmittedAt": "2024-01-01T00:00:00.000Z",
  "analysisCompletedAt": "2024-01-01T00:00:00.000Z",
  "qualityControlledAt": "2024-01-01T00:00:00.000Z",
  "deletedAt": "2024-01-01T00:00:00.000Z",
  "refundedAt": "2024-01-01T00:00:00.000Z",
  "usersNotifiedAt": "2024-01-01T00:00:00.000Z",
  "webhookNotifiedAt": "2024-01-01T00:00:00.000Z",
  "periodChangeStartYear": 2020,
  "periodChangeEndYear": 2023,
  "boundaryPath": "s3://path/to/boundary",
  "calibratedTo": "12341234-1234-1234-1234-123412341234",
  "calibratedFrom": "12341234-1234-1234-1234-123412341234",
  "mangrove": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.