Analytics API

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

startDate

string

Start date for metrics calculation (ISO 8601 format)

endDate

string

End date for metrics calculation (ISO 8601 format)

eventIds

string

Comma-separated list of event IDs to include in metrics

granularity

string

default:"total"

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

Response

carbonFootprint

object

Total carbon footprint metrics

Show properties

totalEmissions

number

Total CO2 emissions in metric tons

emissionsPerAttendee

number

Average emissions per attendee in kg CO2

breakdown

object

Emissions breakdown by category

Show properties

travel

number

Emissions from attendee travel (kg CO2)

venue

number

Emissions from venue energy use (kg CO2)

catering

number

Emissions from food and beverages (kg CO2)

materials

number

Emissions from event materials (kg CO2)

waste

number

Emissions from waste disposal (kg CO2)

offsetTotal

number

Total carbon offset contributions in metric tons

offsetPercentage

number

Percentage of emissions offset

wasteManagement

object

Waste reduction and recycling metrics

Show properties

totalWaste

number

Total waste generated in kg

recycled

number

Amount recycled in kg

composted

number

Amount composted in kg

landfill

number

Amount sent to landfill in kg

diversionRate

number

Waste diversion rate as percentage

wastePerAttendee

number

Average waste per attendee in kg

energyConsumption

object

Energy usage metrics

Show properties

totalEnergy

number

Total energy consumed in kWh

renewablePercentage

number

Percentage from renewable sources

energyPerAttendee

number

Average energy per attendee in kWh

breakdown

object

Energy breakdown by source

sustainablePractices

object

Adoption of sustainable practices

Show properties

localSourcing

number

Percentage of events using local sourcing

digitalFirst

number

Percentage of events using digital materials

publicTransit

number

Percentage of attendees using public transit

vegetarianOptions

number

Percentage of meals that are vegetarian/vegan

reusableMaterials

number

Percentage using reusable materials

certifications

object

Sustainability certifications achieved

Show properties

iso20121

integer

Number of ISO 20121 certified events

leedCertified

integer

Number of events in LEED certified venues

carbonNeutral

integer

Number of carbon neutral events

trends

array

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

summary

object

Summary statistics

Show properties

totalEvents

integer

Total number of events analyzed

totalAttendees

integer

Total number of attendees

dateRange

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"

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

eventId

string

Event identifier

eventName

string

Event name

attendance

object

Attendance metrics

Show properties

registered

integer

Total registrations

checkedIn

integer

Number of attendees checked in

noShow

integer

Number of no-shows

cancelled

integer

Cancelled registrations

attendanceRate

number

Attendance rate as percentage

capacityUtilization

number

Percentage of capacity used

demographics

object

Attendee demographics

Show properties

ticketTypes

object

Breakdown by ticket type

companies

array

Top companies represented

locations

object

Geographic distribution

sustainability

object

Event-specific sustainability metrics

Show properties

carbonFootprint

number

Total emissions in kg CO2

carbonOffsetParticipation

number

Percentage participating in offset program

wasteGenerated

number

Total waste in kg

recyclingRate

number

Recycling rate as percentage

sustainabilityScore

number

Overall sustainability score (0-100)

engagement

object

Engagement metrics

Show properties

averageSessionDuration

number

Average time spent at event in minutes

sessionsAttended

object

Session attendance breakdown

networkingConnections

integer

Number of networking connections made

appDownloads

integer

Event app downloads

financial

object

Financial metrics

Show properties

totalRevenue

number

Total revenue in USD

revenuePerAttendee

number

Average revenue per attendee

ticketSales

object

Sales breakdown by ticket type

refunds

number

Total refunds issued

feedback

object

Attendee feedback summary

Show properties

averageRating

number

Average event rating (1-5)

responseRate

number

Survey response rate as percentage

nps

number

Net Promoter Score

topComments

array

Most common feedback themes

Example

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

Get Trend Data

GET /api/analytics/trends

Retrieve trend analysis and comparative metrics across events.

Query Parameters

metric

string

required

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

startDate

string

required

Start date for trend analysis (ISO 8601 format)

endDate

string

required

End date for trend analysis (ISO 8601 format)

granularity

string

default:"monthly"

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

Response

metric

string

The metric being analyzed

dateRange

object

Date range of analysis

Show properties

start

string

Start date

end

string

End date

dataPoints

array

Time series data points

Show properties

date

string

Data point date

value

number

Metric value

eventCount

integer

Number of events in period

statistics

object

Statistical analysis

Show properties

average

number

Average value across period

median

number

Median value

min

number

Minimum value

max

number

Maximum value

standardDeviation

number

Standard deviation

trend

string

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

changePercentage

number

Percentage change over period

benchmark

object

Industry benchmark comparison (if requested)

Show properties

industryAverage

number

Industry average for metric

percentile

number

Your percentile ranking (0-100)

comparison

string

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

insights

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"

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:

error

object

Error details

Show properties

code

string

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

message

string

Human-readable error message

details

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

Endpoints

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

Build docs developers (and LLMs) love

Overview

Endpoints

​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

Build docs developers (and LLMs) love

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