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

Spend level widget

post deprecatedhttps://api.getgreenspark.com/widgets/spend-level-widget

Fetching a widget that describes a given store’s spend level impact settings.

URL Expired

The URL for this request expired after 30 days.

Query Params

lng

string

Defaults to en

Set the widget's language. Currently supported languages are: English (en), German (de)

Body Params

shopUniqueName

string

required

Defaults to YOUR-SHOP-NAME

The name of your store as it is saved in Greenspark. For example: example.myshopify.com

color

string

required

Defaults to green

Set the widget colour. Current options include: "beige" | "green" | "blue" | "white" | "black"

currency

string

required

Defaults to USD

This is the customer or shop currency. For example: "USD" | "GBP" | "EUR" | "AUD" | "NZD"

withPopup

boolean

Defaults to false

Adds a popup for the response, triggered by clicking on the widget

Responses

Response body

object

Response body

object

Updated 6 months ago

Localisation

Spend level widget v2

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
12
1
curl --request POST \
2
     --url 'https://api.getgreenspark.com/widgets/spend-level-widget?lng=en' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "shopUniqueName": "YOUR-SHOP-NAME",
8
  "color": "green",
9
  "currency": "USD",
10
  "withPopup": false
11
}
12
'

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

application/json

Updated 6 months ago

Localisation

Spend level widget v2

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

200200

400400