Sign in

v1

latestOpenAPI 3.1.02026-07-23103037.2 KB
api

Retrieve a specific dataset by its ID, optionally with scores

This endpoint allows retrieving a specific dataset using its ID. Optionally, it can also return impact scores for the specified indicators.

get/v3/api1/datasets/{id}

Path parameters

idinteger required

Dataset ID to retrieve

Dataset ID to retrieve

Query parameters

indicator_idsinteger[]

List of indicator IDs to retrieve. Provide multiple values via repeated query parameters (?indicator_ids=1&indicator_ids=2). Comma-separated values are not supported.

List of indicator IDs to retrieve. Provide multiple values via repeated query parameters (?indicator_ids=1&indicator_ids=2). Comma-separated values are not supported.

versionstring

Version name or 'latest'

Version name or 'latest'

system_modelstring

System model name or 'cutoff'

System model name or 'cutoff'

Response

Successful response with the requested dataset

idinteger required

Id of the dataset

activitystring required
productstring
geographystring required
descriptionstring
included_activity_startsstring

Included activity starts

included_activity_endsstring

Included activity ends

time_period_commentstring

Time period comment

technology_commentstring

Technology comment

unitstring
time_periodstring required
activity_type'TRANSFORMING_ACTIVITY' | 'MARKET_ACTIVITY' | 'IO_ACTIVITY' | 'RESIDUAL_ACTIVITY' | 'PRODUCTION_MIX' | 'IMPORT_ACTIVITY' | 'SUPPLY_MIX' | 'EXPORT_ACTIVITY' | 'RE_EXPORT_ACTIVITY' | 'CORRECTION_ACTIVITY' | 'MARKET_GROUP' required
isic_sectionstring

Standard Classification of all Economic activities, level 1 section

isic_classstring

Standard Classification of all Economic activities, level 4 class

sectorsstring[] required

Industrial Sector i.e. Electricity

activity_spold_uuidstring required

UUID of the associated activity in spold

product_spold_uuidstring required

UUID of the associated product in spold

geography_spold_uuidstring required

UUID of the associated geography in spold

ecoquery_urlstring required
ecoquery_history_urlstring required