Questionnaire API (POST)

post https://api.connect.earth/questionnaire

This API takes in a userId with the user habits and general configuration and store it in the Connect Earth database to later be used in the Connect CO2 (async) and Connect Insights (async) endpoints.

Body Params

userId

string

required

Defaults to user-123

Unique ID of the user

geo

string

required

Defaults to BE

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

num_people_purchasing_for

number

≥ 1

Defaults to 1

Number of People Purchasing For: Specify the number of individuals for whom purchases are being made. This will be used to calculate emissions per person.

diet

object

utility_bills

object

Household Utility Bill Usage: Indicate which utilities are present in the user's household. Values should be either 0 (not present) or 1 (present)

car_type

object

Types of Cars Used by the Household: Specify the number of cars of each type currently in use within the household. Values must range from 0 to 20.

renewable_electricity

boolean

Defaults to false

Renewable Electricity Usage: Indicate whether the household uses renewable electricity.

start_date

date

Start date in YYYY-MM-DD format

Headers

x-api-key

string

required

Responses

Language

URL


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

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

application/json

200OK (A JSON object with the inserted values)

401Unauthorised (API Key is wrong)

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

429Too Many Requests (API Quota has been exceeded)