Get Climate Impact Data
Returns information about the total climate impact of the carbon credit purchases for this account (or a subaccount). This is the underlying information that is displayed on the hosted public impact page for the account / subaccount. You can optionally use the ‘from’ and/or ‘to’ query parameters to only show impact for orders in a particular time period.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
If present, scopes the operation to the subaccount with given id. See Subaccounts for more info.
Query Parameters
Optionally specifies the start of the time period of orders to include in the impact calculation. If omitted, then orders starting from account creation are included. If present, must be a date in ISO 8601 format.
Optionally specifies the end of the time period of orders to include in the impact calculation. If omitted, then orders up to the present time are included. If present, must be a date in ISO 8601 format.
Response
The categories that contributed to the impact for this account or subaccount, and details about their contribution to the overall impact
Equivalent quantities to illustrate the climate impact of the total credits retired
URL for the logo of the account or subaccount whose impact data is being retrieved
The name for the account or subaccount whose impact data is being retrieved
If an explicit "from" date was specified for the impact data request, then this is the requested "from" date. Otherwise, this is the date on which the account / subaccount began using CNaught to take climate action.
If an explicit "to" date was specified for the impact data request, then this is the requested "to" date. Otherwise, this is null.
Amount (in kg of CO<sub>2</sub>e) of total credits retired for this account or subaccount