Request

Response

    Beta APIs are subject to change. Please avoid using them in production environments.

    Filter Baseline Impact Indicators

    This task shows you how to retrieve and filter environmental impact indicators for a specific baseline. Impact indicators provide detailed lifecycle assessment (LCA) data across different lifecycle stages, helping you understand the environmental footprint of baseline estimates for building materials and products.

    By the end of this task, you will know how to:

    • Call the impact indicators filter endpoint for a specific baseline
    • Understand different impact indicator types (GWP, ADPE, AP, etc.)
    • Interpret lifecycle stage data (A1-A3, A4-A5, B1-B5, C1-C4, D)
    • Work with reference periods for use-stage impacts
    • Compare environmental impacts across different indicators for baselines

    You use the following operation for this task:

    OperationHTTP Request
    Filter Impact Indicators for Baseline POST /v3/datasets/{datasetId}/baselines/details/{id}/impacts:filter

    Prerequisites

    Before starting this task, ensure you have:


    Step 1: Call the Impact Indicators Filter Endpoint

    Use the access token from Obtain an Access Token, a dataset ID from Get the List of Supported Datasets, and a baseline ID from Filter Baselines to retrieve impact indicators for a specific baseline.

    Replace <YOUR_ACCESS_TOKEN>, <DATASET_ID>, and <BASELINE_ID> with your values.

    curl -v 'https://developer.api.autodesk.com/sustainability/v3/datasets/<DATASET_ID>/baselines/details/<BASELINE_ID>/impacts:filter' \
      -X 'POST' \
      -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -d '{
        "filters": {}
      }'
    
    Show More
    const accessToken = "<YOUR_ACCESS_TOKEN>";
    const datasetId = "<DATASET_ID>";
    const baselineId = "<BASELINE_ID>";
    const url = `https://developer.api.autodesk.com/sustainability/v3/datasets/${datasetId}/baselines/details/${baselineId}/impacts:filter`;
    
    const filterCriteria = {
      filters: {}
    };
    
    fetch(url, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${accessToken}`,
        'Content-Type': 'application/json',
        'Accept': 'application/json'
      },
      body: JSON.stringify(filterCriteria)
    })
    .then(response => response.json())
    .then(data => {
      console.log(`Found ${data.results.length} impact indicators for baseline:`);
    
      data.results.forEach((indicator, index) => {
        console.log(`\nIndicator ${index + 1}: ${indicator.indicator.toUpperCase()}`);
        console.log(`  Methodology: ${indicator.methodology}`);
        console.log(`  Declared Unit: ${indicator.declaredUnit.qty} ${indicator.declaredUnit.unit}`);
    
        // Display lifecycle stages with values
        const stages = ['a1', 'a2', 'a3', 'a1a2a3', 'a4', 'a5', 'b1', 'b2', 'b3', 'b4', 'b5', 'c1', 'c2', 'c3', 'c4', 'd'];
        stages.forEach(stage => {
          const stageData = indicator[stage];
          if (stageData && stageData.qty !== null) {
            let output = `  ${stage.toUpperCase()}: ${stageData.qty} ${stageData.unit}`;
            if (stageData.referencePeriod) {
              output += ` (over ${stageData.referencePeriod.qty} ${stageData.referencePeriod.unit})`;
            }
            console.log(output);
          }
        });
      });
    
    })
    .catch(error => console.error('Error:', error));
    
    Show More
    import requests
    
    access_token = "<YOUR_ACCESS_TOKEN>"
    dataset_id = "<DATASET_ID>"
    baseline_id = "<BASELINE_ID>"
    url = f"https://developer.api.autodesk.com/sustainability/v3/datasets/{dataset_id}/baselines/details/{baseline_id}/impacts:filter"
    
    headers = {
        'Authorization': f'Bearer {access_token}',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    }
    
    filter_data = { "filters": {} }
    
    response = requests.post(url, headers=headers, json=filter_data)
    
    if response.status_code == 200:
        data = response.json()
        print(f"Found {len(data['results'])} impact indicators for baseline:")
    
        for index, indicator in enumerate(data['results'], 1):
            print(f"\nIndicator {index}: {indicator['indicator'].upper()}")
            print(f"  Methodology: {indicator['methodology']}")
            declared_unit = indicator['declaredUnit']
            print(f"  Declared Unit: {declared_unit['qty']} {declared_unit['unit']}")
    
            # Display lifecycle stages with values
            stages = ['a1', 'a2', 'a3', 'a1a2a3', 'a4', 'a5', 'b1', 'b2', 'b3', 'b4', 'b5', 'c1', 'c2', 'c3', 'c4', 'd']
            for stage in stages:
                stage_data = indicator.get(stage)
                if stage_data and stage_data.get('qty') is not None:
                    output = f"  {stage.upper()}: {stage_data['qty']} {stage_data['unit']}"
                    if 'referencePeriod' in stage_data and stage_data['referencePeriod']:
                        ref_period = stage_data['referencePeriod']
                        output += f" (over {ref_period['qty']} {ref_period['unit']})"
                    print(output)
    
    else:
        print(f"Error: {response.status_code} - {response.text}")
    
    Show More
    using System;
    using System.Net.Http;
    using System.Text;
    using System.Threading.Tasks;
    using Newtonsoft.Json;
    
    public class BaselineImpactService
    {
        private readonly HttpClient _httpClient;
    
        public BaselineImpactService()
        {
            _httpClient = new HttpClient();
        }
    
        public async Task GetBaselineImpactIndicatorsAsync(string accessToken, string datasetId, string baselineId)
        {
            string url = $"https://developer.api.autodesk.com/sustainability/v3/datasets/{datasetId}/baselines/details/{baselineId}/impacts:filter";
    
            _httpClient.DefaultRequestHeaders.Clear();
            _httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken}");
            _httpClient.DefaultRequestHeaders.Add("Accept", "application/json");
    
            var filterData = new { filters = new { } };
            string jsonContent = JsonConvert.SerializeObject(filterData);
            var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
    
            try
            {
                HttpResponseMessage response = await _httpClient.PostAsync(url, content);
                response.EnsureSuccessStatusCode();
    
                string responseContent = await response.Content.ReadAsStringAsync();
                dynamic data = JsonConvert.DeserializeObject(responseContent);
    
                Console.WriteLine($"Found {data.results.Count} impact indicators for baseline:");
    
                for (int i = 0; i < data.results.Count; i++)
                {
                    var indicator = data.results[i];
                    Console.WriteLine($"\nIndicator {i + 1}: {indicator.indicator.ToString().ToUpper()}");
                    Console.WriteLine($"  Methodology: {indicator.methodology}");
                    Console.WriteLine($"  Declared Unit: {indicator.declaredUnit.qty} {indicator.declaredUnit.unit}");
    
                    // Display lifecycle stages with values
                    string[] stages = { "a1", "a2", "a3", "a1a2a3", "a4", "a5", "b1", "b2", "b3", "b4", "b5", "c1", "c2", "c3", "c4", "d" };
                    foreach (string stage in stages)
                    {
                        var stageData = indicator[stage];
                        if (stageData != null && stageData.qty != null)
                        {
                            string output = $"  {stage.ToUpper()}: {stageData.qty} {stageData.unit}";
                            if (stageData.referencePeriod != null)
                            {
                                output += $" (over {stageData.referencePeriod.qty} {stageData.referencePeriod.unit})";
                            }
                            Console.WriteLine(output);
                        }
                    }
                }
    
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error: {ex.Message}");
            }
        }
    }
    
    Show More

    Step 2: Understanding the Response

    The response provides comprehensive environmental impact data across different lifecycle stages following LCA (Life Cycle Assessment) methodology.

    Example Response

    {
      "results": [
        {
          "declaredUnit": {
            "qty": 1,
            "unit": "m3"
          },
          "indicator": "gwp",
          "methodology": "TRACI2.1",
          "a1": null,
          "a2": null,
          "a3": null,
          "a1a2a3": {
            "qty": 15.2,
            "unit": "kgCO2eq"
          },
          "a4": {
            "qty": 2.8,
            "unit": "kgCO2eq"
          },
          "a5": {
            "qty": 1.1,
            "unit": "kgCO2eq"
          },
          "b1": {
            "qty": 0.3,
            "unit": "kgCO2eq",
            "referencePeriod": {
              "qty": 50,
              "unit": "year"
            }
          },
          "b2": null,
          "b3": null,
          "b4": null,
          "b5": null,
          "b1b2b3b4b5": {
            "qty": 0.3,
            "unit": "kgCO2eq",
            "referencePeriod": {
              "qty": 50,
              "unit": "year"
            }
          },
          "c1": {
            "qty": 0.15,
            "unit": "kgCO2eq"
          },
          "c2": null,
          "c3": null,
          "c4": {
            "qty": 0.08,
            "unit": "kgCO2eq"
          },
          "c1c2c3c4": {
            "qty": 0.23,
            "unit": "kgCO2eq"
          },
          "d": null
        },
        {
          "declaredUnit": {
            "qty": 1,
            "unit": "m3"
          },
          "indicator": "adpe",
          "methodology": "CML2001",
          "a1": null,
          "a2": null,
          "a3": null,
          "a1a2a3": {
            "qty": 0.0012,
            "unit": "kgSbeq"
          },
          "a4": null,
          "a5": null,
          "b1": null,
          "b2": null,
          "b3": null,
          "b4": null,
          "b5": null,
          "b1b2b3b4b5": null,
          "c1": null,
          "c2": null,
          "c3": null,
          "c4": null,
          "c1c2c3c4": null,
          "d": null
        }
      ],
      "appliedFilters": {},
      "ignoredFilters": {}
    }
    
    Show More

    Key Response Fields:

    • results: Array of impact indicators, each with lifecycle stage data
    • indicator: Type of environmental impact (gwp, adpe, ap, etc.)
    • methodology: Assessment methodology used (TRACI2.1, CML2001, etc.)
    • declaredUnit: Functional unit for all impact measurements
    • a1-a3: Individual production stage impacts (raw materials, transport, manufacturing)
    • a1a2a3: Combined production stage impacts (most commonly reported)
    • a4 / a5: Construction stage impacts (transport, installation)
    • b1-b5: Use stage impacts (operation, maintenance, repair, etc.)
    • b1b2b3b4b5: Aggregate use stage impacts (sum of B1-B5)
    • c1-c4: End-of-life stage impacts (deconstruction, disposal)
    • c1c2c3c4: Aggregate end-of-life stage impacts (sum of C1-C4)
    • d: Benefits and loads beyond system boundary
    • referencePeriod: Time period for B-stage impacts (e.g., 50 years)
    • appliedFilters: Map of filter keys to the requested vs. applied filter values (with optional warnings when a value was dropped)
    • appliedFilters.*.requested: The filter value the client asked for (object with op and value)
    • appliedFilters.*.applied: The filter value the connector actually applied (object with op and value)
    • appliedFilters.*.warnings: Optional human-readable notes about values that could not be applied
    • ignoredFilters: Map of unrecognised filter keys to the reason they were ignored
    • ignoredFilters.*.reason: Human-readable explanation of why the filter key was not used

    Step 3: Understanding Impact Indicators

    Common Impact Indicators:

    • GWP (Global Warming Potential): Climate change impact measured in CO2 equivalents
    • ADPE (Abiotic Depletion Potential - Elements): Resource depletion for elements
    • AP (Acidification Potential): Environmental acidification impact
    • EP (Eutrophication Potential): Water and soil nutrient enrichment
    • ODP (Ozone Depletion Potential): Stratospheric ozone layer depletion
    • POCP (Photochemical Ozone Creation Potential): Ground-level ozone formation

    Lifecycle Stages:

    • A1-A3: Product stage (raw materials, transport, manufacturing)
    • A4-A5: Construction process stage (transport to site, installation)
    • B1-B5: Use stage (operation, maintenance, repair, replacement, refurbishment, operational water/energy use)
    • C1-C4: End-of-life stage (deconstruction, transport, waste processing, disposal)
    • D: Benefits and loads beyond system boundary (reuse, recovery, recycling potential)

    Practical Applications:

    • Baseline Comparison: Compare baseline estimates with actual product EPDs
    • Environmental Benchmarking: Establish reference values for material categories
    • Impact Assessment: Understand environmental hotspots in baseline estimates
    • Methodology Analysis: Compare different assessment methodologies

    Data Interpretation:

    • Null Values: Indicate stages not assessed or not applicable for this baseline
    • Reference Periods: B-stage impacts are normalized to specific time periods
    • Units: Pay attention to units as they vary by impact indicator
    • Methodology: Different methodologies may yield different results

    Integration with Other Tasks:

    Troubleshooting:

    If you encounter any errors while making this request, please refer to the Error Handling section of this guide for detailed information about common error codes and their solutions.