API Reference

Monthly Insights Breakdown API

post
https://api.connect.earth/monthly-insights/breakdown

Call this endpoint to get the aggregated data of a user's emissions for a specific month or range of months with a breakdown by either category group, merchant or group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Include here the userId, startMonth/endMonth or months, and groupBy for the insights. Add fixedEquivalents optionally to get the fixed equivalents of the emissions per month.

required

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

string
Defaults to 2022-01

Start month of the period you want to be returned in the response.

string
Defaults to 2022-03

End month of the period you want to be returned in the response.

months
array of strings

List of months you want to be returned in the response in YYYY-MM format, with a maximum of 12 months.

months
string
enum
required

Defines the level of aggregation for the returned results:

  • merchant: Groups results by individual merchants.
    This is the most granular view, showing spend or activity broken down per merchant.

  • category: Groups results by spending category (e.g. Groceries, Restaurants).
    Provides a mid-level view of activity across multiple merchants within the same category.

  • group: Groups results into broader collections of categories.
    Each group combines multiple related categories (e.g. Food & Dining may include both Groceries and Restaurants), giving a higher-level overview of major spending areas.

Allowed:
fixedEquivalents
array of strings

List of equivalent types you want to be returned in the response to compare your emissions against. Options are comparing against mileage in a car and amount of CO2 absorbed by number of trees.

fixedEquivalents
boolean

Returns the total emissions by month if set to false or return the aggregate of all the months in the period if set to true.

categoryFilter
array of strings

Filter the monthly totals by category.

categoryFilter
Headers
string
required
Responses

Updated 7 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 7 months ago