Pie Chart Insights API

post https://api.connect.earth/transaction/bulk/upload/chart

This API takes in either a list of transactionIDs (previously stored by Connect Earth with the batch upload endpoints) or one/multiple userIds and returns a user's emissions breakdown by group, useful environmental recommendations to reduce emissions, well-done comments and content to encourage and educate users.

Body Params

Object with transaction array needed to provide CO2e estimates

userId

required

Defaults to user-123

Unique ID of the user. This parameter can be a single userId or an array of userIds

geo

string

Defaults to BE

Indicates the specific country that should be used for the CO2 emissions factors (see all countries supported).

userType

string

Indicates whether the API should use emissions factors for people or businesses. Either: "PERSONAL"(default), "BUSINESS")

startDate

string

endDate

string

transactions

array of objects

transactions

fixedEquivalents

array of strings

List of equivalent types you want to be returned in the response.

fixedEquivalents

Headers

x-api-key

string

required

Responses

Language

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.connect.earth/transaction/bulk/upload/chart \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "userId": "user-123",
8
  "geo": "BE"
9
}
10
'

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

application/json

200OK (A JSON object with an array of CO2e estimates data and errors)

400Bad Request (Likely something wrong with the input)

401Unauthorised (API Key is wrong)

413Request Entity Too Large (Happens if you send more than 2000 transactions in one request)

429Too Many Requests (API Quota has been exceeded)