API Reference

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. The data is then used to personalise the experince for the user, adjusting emission estimates and tailoring recommendations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to user-123

Unique ID of the user

string
enum
required
Defaults to BE

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

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 within the household. For example, if you are purchasing for 2 people, the emissions will be divided by 2.

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.

boolean
Defaults to false

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

reg_elec_tariff
object

Regional Electricity Tariff Configuration: Specify nationality and regional electricity tariff of the user with binary indicators (0 or 1).

date

This is the date from which these user habits should be appllied. If no date is provided then today's date will be used. If a date in the past is provided then the user habits will be applied from that date onwards. This backfilling could take some time to complete, you can use the processing flag to in other endpoints to monitor when this has been completed.`

Headers
string
required
Responses

Updated 8 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago