Analytics API - EcoEvents

Overview

The Analytics API provides comprehensive insights into event performance, sustainability metrics, carbon footprint tracking, and trend analysis. Use these endpoints to monitor environmental impact and optimize future events.

Authentication

All API requests require an API key to be included in the header:

Authorization: Bearer YOUR_API_KEY

Get Sustainability Metrics

GET /api/analytics/sustainability

Retrieve comprehensive sustainability metrics across all events or filtered by date range.

Query Parameters

string

Start date for metrics calculation (ISO 8601 format)

string

End date for metrics calculation (ISO 8601 format)

string

Comma-separated list of event IDs to include in metrics

string

default:"total"

Data granularity (“total”, “daily”, “weekly”, “monthly”)

Response

object

Total carbon footprint metrics

Show properties

number

Total CO2 emissions in metric tons

number

Average emissions per attendee in kg CO2

object

Emissions breakdown by category

Show properties

number

Emissions from attendee travel (kg CO2)

number

Emissions from venue energy use (kg CO2)

number

Emissions from food and beverages (kg CO2)

number

Emissions from event materials (kg CO2)

number

Emissions from waste disposal (kg CO2)

number

Total carbon offset contributions in metric tons

number

Percentage of emissions offset

object

Waste reduction and recycling metrics

Show properties

number

Total waste generated in kg

number

Amount recycled in kg

number

Amount composted in kg

number

Amount sent to landfill in kg

number

Waste diversion rate as percentage

number

Average waste per attendee in kg

object

Energy usage metrics

Show properties

number

Total energy consumed in kWh

number

Percentage from renewable sources

number

Average energy per attendee in kWh

object

Energy breakdown by source

object

Adoption of sustainable practices

Show properties

number

Percentage of events using local sourcing

number

Percentage of events using digital materials

number

Percentage of attendees using public transit

number

Percentage of meals that are vegetarian/vegan

number

Percentage using reusable materials

object

Sustainability certifications achieved

Show properties

integer

Number of ISO 20121 certified events

integer

Number of events in LEED certified venues

integer

Number of carbon neutral events

array

Historical trend data (if granularity is not “total”)

object

Summary statistics

Show properties

integer

Total number of events analyzed

integer

Total number of attendees

object

Date range of analysis

Example

curl -X GET "https://api.ecoevents.com/api/analytics/sustainability?startDate=2026-01-01T00:00:00Z&endDate=2026-12-31T23:59:59Z&granularity=monthly" \
  -H "Authorization: Bearer YOUR_API_KEY"

const params = new URLSearchParams({
  startDate: '2026-01-01T00:00:00Z',
  endDate: '2026-12-31T23:59:59Z',
  granularity: 'monthly'
});

const response = await fetch(`https://api.ecoevents.com/api/analytics/sustainability?${params}`, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const metrics = await response.json();
console.log(metrics);

import requests

url = 'https://api.ecoevents.com/api/analytics/sustainability'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}
params = {
    'startDate': '2026-01-01T00:00:00Z',
    'endDate': '2026-12-31T23:59:59Z',
    'granularity': 'monthly'
}

response = requests.get(url, headers=headers, params=params)
metrics = response.json()
print(metrics)

Response Example

{
  "carbonFootprint": {
    "totalEmissions": 45.8,
    "emissionsPerAttendee": 91.6,
    "breakdown": {
      "travel": 25000,
      "venue": 12000,
      "catering": 6000,
      "materials": 2500,
      "waste": 300
    },
    "offsetTotal": 40.2,
    "offsetPercentage": 87.8
  },
  "wasteManagement": {
    "totalWaste": 850,
    "recycled": 420,
    "composted": 280,
    "landfill": 150,
    "diversionRate": 82.4,
    "wastePerAttendee": 1.7
  },
  "energyConsumption": {
    "totalEnergy": 2400,
    "renewablePercentage": 75,
    "energyPerAttendee": 4.8,
    "breakdown": {
      "solar": 1200,
      "wind": 600,
      "grid": 600
    }
  },
  "sustainablePractices": {
    "localSourcing": 85,
    "digitalFirst": 92,
    "publicTransit": 45,
    "vegetarianOptions": 68,
    "reusableMaterials": 78
  },
  "certifications": {
    "iso20121": 3,
    "leedCertified": 5,
    "carbonNeutral": 4
  },
  "summary": {
    "totalEvents": 8,
    "totalAttendees": 2450,
    "dateRange": {
      "start": "2026-01-01T00:00:00Z",
      "end": "2026-12-31T23:59:59Z"
    }
  }
}

Get Event Analytics

GET /api/analytics/events/:id

Retrieve detailed analytics for a specific event.

Path Parameters

string

required

The unique identifier of the event

Response

string

Event identifier

string

Event name

object

Attendance metrics

Show properties

integer

Total registrations

integer

Number of attendees checked in

integer

Number of no-shows

integer

Cancelled registrations

number

Attendance rate as percentage

number

Percentage of capacity used

object

Attendee demographics

Show properties

object

Breakdown by ticket type

array

Top companies represented

object

Geographic distribution

object

Event-specific sustainability metrics

Show properties

number

Total emissions in kg CO2

number

Percentage participating in offset program

number

Total waste in kg

number

Recycling rate as percentage

number

Overall sustainability score (0-100)

object

Engagement metrics

Show properties

number

Average time spent at event in minutes

object

Session attendance breakdown

integer

Number of networking connections made

integer

Event app downloads

object

Financial metrics

Show properties

number

Total revenue in USD

number

Average revenue per attendee

object

Sales breakdown by ticket type

number

Total refunds issued

object

Attendee feedback summary

Show properties

number

Average event rating (1-5)

number

Survey response rate as percentage

number

Net Promoter Score

array

Most common feedback themes

Example

curl -X GET https://api.ecoevents.com/api/analytics/events/evt_1a2b3c4d5e6f \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.ecoevents.com/api/analytics/events/evt_1a2b3c4d5e6f', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const analytics = await response.json();
console.log(analytics);

import requests

url = 'https://api.ecoevents.com/api/analytics/events/evt_1a2b3c4d5e6f'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}

response = requests.get(url, headers=headers)
analytics = response.json()
print(analytics)

Get Trend Data

GET /api/analytics/trends

Retrieve trend analysis and comparative metrics across events.

Query Parameters

string

required

Metric to analyze (“carbon_emissions”, “attendance”, “waste_reduction”, “energy_usage”, “offset_participation”)

string

required

Start date for trend analysis (ISO 8601 format)

string

required

End date for trend analysis (ISO 8601 format)

string

default:"monthly"

Time granularity (“daily”, “weekly”, “monthly”, “quarterly”)

string

Filter by event category

boolean

default:"false"

Include industry benchmark comparison

Response

string

The metric being analyzed

object

Date range of analysis

Show properties

string

Start date

string

End date

array

Time series data points

Show properties

string

Data point date

number

Metric value

integer

Number of events in period

object

Statistical analysis

Show properties

number

Average value across period

number

Median value

number

Minimum value

number

Maximum value

number

Standard deviation

string

Trend direction (“increasing”, “decreasing”, “stable”)

number

Percentage change over period

object

Industry benchmark comparison (if requested)

Show properties

number

Industry average for metric

number

Your percentile ranking (0-100)

string

Performance vs industry (“above”, “average”, “below”)

array

AI-generated insights and recommendations

Example

curl -X GET "https://api.ecoevents.com/api/analytics/trends?metric=carbon_emissions&startDate=2026-01-01T00:00:00Z&endDate=2026-12-31T23:59:59Z&granularity=monthly&comparison=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

const params = new URLSearchParams({
  metric: 'carbon_emissions',
  startDate: '2026-01-01T00:00:00Z',
  endDate: '2026-12-31T23:59:59Z',
  granularity: 'monthly',
  comparison: 'true'
});

const response = await fetch(`https://api.ecoevents.com/api/analytics/trends?${params}`, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const trends = await response.json();
console.log(trends);

import requests

url = 'https://api.ecoevents.com/api/analytics/trends'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}
params = {
    'metric': 'carbon_emissions',
    'startDate': '2026-01-01T00:00:00Z',
    'endDate': '2026-12-31T23:59:59Z',
    'granularity': 'monthly',
    'comparison': True
}

response = requests.get(url, headers=headers, params=params)
trends = response.json()
print(trends)

Response Example

{
  "metric": "carbon_emissions",
  "dateRange": {
    "start": "2026-01-01T00:00:00Z",
    "end": "2026-12-31T23:59:59Z"
  },
  "dataPoints": [
    {
      "date": "2026-01",
      "value": 5200,
      "eventCount": 2
    },
    {
      "date": "2026-02",
      "value": 4800,
      "eventCount": 1
    }
  ],
  "statistics": {
    "average": 5725,
    "median": 5600,
    "min": 3200,
    "max": 8500,
    "standardDeviation": 1250,
    "trend": "decreasing",
    "changePercentage": -12.5
  },
  "benchmark": {
    "industryAverage": 6500,
    "percentile": 72,
    "comparison": "above"
  },
  "insights": [
    "Carbon emissions decreased by 12.5% over the year",
    "Your events produce 11.9% less emissions than industry average",
    "Consider increasing renewable energy usage to reach top 10% percentile"
  ]
}

Error Responses

All endpoints may return the following error responses:

object

Error details

Show properties

string

Error code (e.g., “INVALID_REQUEST”, “INSUFFICIENT_DATA”, “UNAUTHORIZED”)

string

Human-readable error message

object

Additional error context (optional)

Common Error Codes

Status Code	Error Code	Description
400	INVALID_REQUEST	Invalid request parameters
400	INVALID_DATE_RANGE	Invalid or unsupported date range
400	INSUFFICIENT_DATA	Not enough data for requested analysis
401	UNAUTHORIZED	Missing or invalid API key
403	FORBIDDEN	Insufficient permissions
404	NOT_FOUND	Event not found
429	RATE_LIMIT_EXCEEDED	Too many requests
500	INTERNAL_ERROR	Server error

​Overview

​Authentication

​Get Sustainability Metrics

GET /api/analytics/sustainability

​Query Parameters

​Response

​Example

​Response Example

​Get Event Analytics

GET /api/analytics/events/:id

​Path Parameters

​Response

​Example

​Get Trend Data

GET /api/analytics/trends

​Query Parameters

​Response

​Example

​Response Example

​Error Responses

​Common Error Codes

Overview

Authentication

Get Sustainability Metrics

Query Parameters

Response

Example

Response Example

Get Event Analytics

Path Parameters

Response

Example

Get Trend Data

Query Parameters

Response

Example

Response Example

Error Responses

Common Error Codes