Greenspark API

Introduction
How it works
SDKs

Overview

Terminology
Environments
Authentication
Errors
Pagination
Metadata
Timestamps
Impact segmentation

Impact

Impacts

Projects

Projects

Estimations

Estimations

Reporting

Reports

Email

Widget API

Localisation
Widgets

Account Management

Account
- Public Accountget

Greenspark API

Introduction
How it works
SDKs

Overview

Terminology
Environments
Authentication
Errors
Pagination
Metadata
Timestamps
Impact segmentation

Impact

Impacts

Projects

Projects

Estimations

Estimations

Reporting

Reports

Email

Widget API

Localisation
Widgets

Account Management

Account
- Public Accountget

Create Tailored Impact

post https://api.getgreenspark.com/v1/impacts

Creates an impact associated with an account id.

URL Expired

The URL for this request expired after 30 days.

Body Params

impactPurchases

array

required

The impactPurchases array defines the impacts you would like to create.

impactPurchases*

estimationId

string

The id of the estimation that was used to calculate the impact.

metadata

array of objects

In the metadata array you can store up to 10 key-value pairs. You can use them to associate arbitrary data with your impact.

metadata

Responses

Response body

array of objects

object

type

string

required

Type of the impact you purchased.

trees carbon plastic kelp water bees

amount

number

required

Amount of the impact you purchased.

spentValue

number

required

The value which has been spent on your chosen impacts and will therefore be billed.

unspentValue

number

required

Any value which is not spent. This is due to the difference between the value you have chosen to spend and the actual price of the impacts. You will not be billed for this.

projectId

string

required

The id of the project.

400

Bad request.

401

Provide your API key.

403

Please upgrade to a premium or enterprise plan.

404

Not found.

Updated almost 2 years ago

Create Impact

Create Impact in Batch

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.getgreenspark.com/v1/impacts \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated almost 2 years ago

Create Impact

Create Impact in Batch

Did this page help you?

Greenspark API
Introduction
How it works
SDKs

Overview
Terminology
Environments
Authentication
Errors
Pagination
Metadata
Timestamps
Impact segmentation

Impact
Impacts
Fetch Impact Purchaseget
Fetch Impact Purchasesget
Create Impact in Batchpost
Create Tailored Impactpost
Create Impactpost

Projects
Projects
Fetch project by idget
Fetch projectsget
Fetch project categoriesget

Estimations
Estimations
Fetch Carbon Estimate of Multiple Transactions by Open Banking Category Typespost
Fetch Carbon Estimate of a Transaction by Open Banking Category Typespost
Fetch Carbon Estimate of Multiple Transactions by MCCpost
Fetch Carbon Estimate of a Transaction by MCCpost

Reporting
Reports
Fetch Total Impacts Countget
Fetch Average Spend Per Impactget
Fetch Total Spend On Impactsget
Fetch Total Impact By Triggersget
Fetch Total Impact By Sourcesget
Fetch Impacts By Intervalget
Fetch Trees By Intervalget
Fetch Plastic By Intervalget
Fetch Carbon By Intervalget
Fetch Impact Amount By Type Per Trigger Reportget
Fetch Impact Amount By Type Per Source Reportget
Fetch Total Impact By Type Reportget
Fetch a Report Pageget
Fetch Raw Reportget
Fetch Raw Report v2get

Email
Email
Test Templatepost
Delete Templatedelete
Update Templateput
Add Templatepost
Fetch Templatesget
Fetch Templates Defaultsget
Delete Domaindelete
Verify Domainpost
Add Domainpost
Fetch Domainsget

Widget API
Localisation
Widgets
Full width banner v2post
Full width bannerpost
Top stats widget v2post
Top stats widgetpost
Cart widget v2post
Cart widgetpost
Per product widget v2post
Per product widgetpost
Tiered spend level widget v2post
Tiered spend level widgetpost
By percentage of revenue widget v2post
By percentage widget v2post
By percentage widgetpost
Per order widget v2post
Per order widgetpost
Spend level widget v2post
Spend level widgetpost

Account Management
Account
Public Accountget

Greenspark API
Introduction
How it works
SDKs

Overview
Terminology
Environments
Authentication
Errors
Pagination
Metadata
Timestamps
Impact segmentation

Impact
Impacts
Fetch Impact Purchaseget
Fetch Impact Purchasesget
Create Impact in Batchpost
Create Tailored Impactpost
Create Impactpost

Projects
Projects
Fetch project by idget
Fetch projectsget
Fetch project categoriesget

Estimations
Estimations
Fetch Carbon Estimate of Multiple Transactions by Open Banking Category Typespost
Fetch Carbon Estimate of a Transaction by Open Banking Category Typespost
Fetch Carbon Estimate of Multiple Transactions by MCCpost
Fetch Carbon Estimate of a Transaction by MCCpost

Reporting
Reports
Fetch Total Impacts Countget
Fetch Average Spend Per Impactget
Fetch Total Spend On Impactsget
Fetch Total Impact By Triggersget
Fetch Total Impact By Sourcesget
Fetch Impacts By Intervalget
Fetch Trees By Intervalget
Fetch Plastic By Intervalget
Fetch Carbon By Intervalget
Fetch Impact Amount By Type Per Trigger Reportget
Fetch Impact Amount By Type Per Source Reportget
Fetch Total Impact By Type Reportget
Fetch a Report Pageget
Fetch Raw Reportget
Fetch Raw Report v2get

Email
Email
Test Templatepost
Delete Templatedelete
Update Templateput
Add Templatepost
Fetch Templatesget
Fetch Templates Defaultsget
Delete Domaindelete
Verify Domainpost
Add Domainpost
Fetch Domainsget

Widget API
Localisation
Widgets
Full width banner v2post
Full width bannerpost
Top stats widget v2post
Top stats widgetpost
Cart widget v2post
Cart widgetpost
Per product widget v2post
Per product widgetpost
Tiered spend level widget v2post
Tiered spend level widgetpost
By percentage of revenue widget v2post
By percentage widget v2post
By percentage widgetpost
Per order widget v2post
Per order widgetpost
Spend level widget v2post
Spend level widgetpost

Account Management
Account
Public Accountget

201The impact has been successfully created.