Info
Return dataset's basic info.
Request
- Base URLhttps://app.chloris.earth (the document declares no server; this is the origin it was published from)
- AuthAPI key in query parameter access_token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The reporting unit entry's dataPath parameter. Should be used instead of url in most cases.
The carbon pool for the report unit layer. Valid options are: agb, bgb, dom. Defaults to agb. Requires data_path to be set.
The product type for the report unit layer. Valid options are: stock, change, cumulative_change, forest, nonforest, forest_area_gain, forest_area_loss, forest_area_degradation. Requires data_path to be set.
The product variant id for the report unit layer. May be omitted to use the default variant. Requires data_path and product_type to be set. Deprecated in favor of carbon_pool and resolution.
The nominal group distance in meters report unit layer. May be omitted to use highest resolution available for the given zoom level. Requires data_path and product_type to be set.
The year for the report unit layer. Should be used instead of bidx in most cases. Requires data_path and product_type to be set.
The analysisCompletedAt from the report unit entry to ensure the latest data is fetched.
Dataset URL, may be omitted if using data_path (recommended).
Response
Return dataset's basic info.
Changes
No recorded changes to this operation across all 1 revision of this API.