Impact

The Impact API provides a consolidated view of your total environmental impact, making it easy to track and showcase your contributions over time. With a single API call, you can retrieve summary data including the total number of trees planted, ocean waste removed, carbon captured, and donations made.

The response includes both aggregated totals and a breakdown between your direct impact (user_impact) and impact generated on behalf of your customers (customer_impact). The top-level values represent the sum of both user and customer impact. Use this data to power dashboards, generate reports, or share real-time progress toward sustainability goals.


GET/v1/impact

Retrieve your impact

This endpoint allows you to query your total impact, including a breakdown between direct impact and customer impact.

Response Structure

The response includes:

  • Top-level values: Aggregated totals (user_impact + customer_impact)
  • user_impact: Impact generated directly by your organization
  • customer_impact: Impact generated on behalf of your customers

Request

GET
/v1/impact
curl --location 'https://api.1clickimpact.com/v1/impact' \
--header 'x-api-key: {PRODUCTION API KEY}'

Response

{
  "user_id": "U123",
  "tree_planted": 100,
  "waste_removed": 50,
  "carbon_captured": 75,
  "money_donated": 25000,
  "user_impact": {
    "tree_planted": 60,
    "waste_removed": 30,
    "carbon_captured": 45,
    "money_donated": 15000
  },
  "customer_impact": {
    "tree_planted": 40,
    "waste_removed": 20,
    "carbon_captured": 30,
    "money_donated": 10000
  }
}