---
title: "Returns the impacts of current inventory."
method: GET
path: "/impacts"
tags: ["impacts"]
---

# Returns the impacts of current inventory.

`GET /impacts`

Region is mandatory. Filter_tags (if any) should be written as string containing tag_name=tag_value

Example query: http://localhost:8000/impacts?aws_region=eu-west-3&filter_tag=Name=boatest&filter_tag=OtherTag=other-value&use_duration_hours=1.0

## Query parameters

- `aws_region` string, required
- `filter_tags` string[], nullable
- `use_duration_hours` number, float, nullable
- `verbose_output` boolean, nullable
- `include_block_storage` boolean, nullable

## Response `200`

- EstimatedInventory — An estimated inventory: impacting resources with their estimated impacts
  - `metadata` EstimationMetadata, required — Details about the estimation
    - `estimation_date` string, date-time, nullable — The date when the estimation was generated
    - `description` string, nullable — A free text description of the estimation
    - `cloud_scanner_version` string, nullable — The version of the cloud scanner that provided the estimation
    - `boavizta_api_version` string, nullable — The version of the Boavizta api that provided the estimation
    - `execution_statistics` ExecutionStatistics — Statistics about program execution
      - `inventory_duration` Duration, required
        - `secs` integer, required
        - `nanos` integer, required
      - `impact_estimation_duration` Duration, required
        - `secs` integer, required
        - `nanos` integer, required
      - `total_duration` Duration, required
        - `secs` integer, required
        - `nanos` integer, required
  - `impacting_resources` CloudResourceWithImpacts[], required
    - `cloud_resource` CloudResource, required — A cloud resource (could be an instance, block storage or any other resource)
      - `provider` 'AWS' | 'OVH', required
      - `id` string, required
      - `location` UsageLocation, required — The location where cloud resources are running. TODO! the usage location should be abstracted and vendor specific implementation should be part of the cloud_provider model (region names are tied to a specific cloud provider)
        - `aws_region` string, required — The AWS region (like eu-west-1)
        - `iso_country_code` string, required — The 3-letters ISO country code corresponding to the country of the aws_region
      - `resource_details` union, required
        - 'object_storage'
        - object
          - `instance` object, required
            - `instance_type` string, required
            - `usage` InstanceUsage
              - …
        - object
          - `block_storage` object, required
            - `storage_type` string, required
            - `usage` StorageUsage
              - …
            - `attached_instances` StorageAttachment[], nullable
              - …
      - `tags` CloudResourceTag[], required
        - `key` string, required
        - `value` string, nullable
    - `impacts_values` ImpactsValues — Impacts of an individual resource
      - `adp_manufacture_kgsbeq` number, double, required
      - `adp_use_kgsbeq` number, double, required
      - `pe_manufacture_megajoules` number, double, required
      - `pe_use_megajoules` number, double, required
      - `gwp_manufacture_kgco2eq` number, double, required
      - `gwp_use_kgco2eq` number, double, required
      - `raw_data` unknown
    - `impacts_duration_hours` number, float, required — The duration for which impacts are calculated

---

[API](https://skmtc.dev/boavizta/apis/cloud-scanner-cli.md) · [All operations](https://skmtc.dev/boavizta/apis/cloud-scanner-cli/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/boavizta/cloud-scanner-cli/revisions/ae306cb8898d/schema)