impacts field, keyed by the indicator’s canonical code (for example GWP-fossil,
ODP, AP). You choose which indicators to include with the impacts query parameter.
For the full list of indicators and what each one measures, see
Environmental impact indicators.
The impacts field
impacts is an object keyed by indicator code. Each value carries the indicator’s unit and
method, plus its values for the individual life-cycle stages (A1, A2, A3, …) and the
aggregated totals (totalCarbonFootprint, A1_A3, …) the indicator covers.
"0"; one with no value is absent.
The aggregated stage A1_A3 is returned alongside the individual A1, A2, and A3 stages, so
you can read either the combined product stage or its parts. method is Mixed when the total
aggregates two or more components from different methods — common for the headline GWP-fossil total.
The impacts query parameter
Add ?impacts= to any GET that returns these resources to control which indicators come back.
?impacts= value | Returns |
|---|---|
| absent or empty | Only GWP-fossil |
all | Every indicator |
gwp-fossil,odp,ap | Just those indicators (codes are case-insensitive) |
400 with the list of valid codes. all is only honored on its own —
?impacts=all,gwp-fossil is treated as a request for an unknown code and returns 400.
GWP-fossil is always available. Access to the full indicator set may depend on your account.Deprecation: footprint.CO2e
The existing footprint.CO2e object is unchanged and keeps working, but it is deprecated in
favor of impacts["GWP-fossil"], which carries the same GWP-fossil values. Migrate to impacts
when you can; footprint.CO2e has no removal date yet.
Endpoints: Product, Material,
Dataset, Switch, and
Database search.