Reporting API

The Epic-Charging Reporting API provides comprehensive access to charging data, statistics, and metrics across your charging infrastructure. This allows you to monitor usage, analyze performance, and make data-driven decisions.

Available Reports

The Reporting API offers several report types:

1. Charger Status Reports

Get real-time status information about your chargers and their ports.

Endpoint: /report/charger-status/

This report provides:

• Current operational status of all chargers
• Detailed port information
• Health metrics for chargers

Example Request:

curl -X GET "https://{{tenant}}.epiccharging.com/api/external/v1/report/charger-status/" \
  -H "Token-Authorization: your_api_key_here"

2. Charger Reports

Generates a comprehensive report of all chargers with detailed information.

Endpoint: /report/charger/

This report provides:

• Charger locations
• Owner information
• Commission dates
• Total power usage

Example Request:

curl -X GET "https://{{tenant}}.epiccharging.com/api/external/v1/report/charger/" \
  -H "Token-Authorization: your_api_key_here"

3. Charging Session Reports

Provides detailed information about completed charging sessions.

Endpoint: /report/charging-session/

This report provides:

• Session timestamps
• Energy delivered
• Associated costs
• Driver information

Example Request with Date Filtering:

curl -X GET "https://{{tenant}}.epiccharging.com/api/external/v1/report/charging-session/?plug_in_start_datetime__gte=2025-01-01T00:00:00Z&plug_in_start_datetime__lte=2025-01-31T23:59:59Z" \
  -H "Token-Authorization: your_api_key_here"

4. Fault Reports

Lists all system fault events with detailed error information.

Endpoint: /report/faults/

This report provides:

• Error codes and descriptions
• Fault timestamps
• Affected chargers

Example Request with Charger Filtering:

curl -X GET "https://{{tenant}}.epiccharging.com/api/external/v1/report/faults/?charger=123e4567-e89b-12d3-a456-426614174000" \
  -H "Token-Authorization: your_api_key_here"

5. Transaction Reports

Provides detailed charging transaction information.

Endpoint: /report/transaction/

This report provides:

• Transaction timestamps
• Energy usage
• Charging duration
• Stop reasons

Example Request with Date Range:

curl -X GET "https://{{tenant}}.epiccharging.com/api/external/v1/report/transaction/?start_datetime__gte=2025-01-01T00:00:00Z&stop_datetime__lte=2025-01-31T23:59:59Z" \
  -H "Token-Authorization: your_api_key_here"

Report Filtering Options

All report endpoints support pagination with limit and offset parameters. Additionally, each report type supports specific filters:

Charger Status Report Filters

• charger: Filter by specific charger UUID

Charging Session Report Filters

• plug_in_start_datetime__gte: Filter by plug-in start time (minimum)
• plug_in_start_datetime__lte: Filter by plug-in start time (maximum)

Fault Report Filters

• created_at__range: Filter by creation date range
• created_at__gte: Filter by creation date (minimum)
• created_at__lte: Filter by creation date (maximum)
• charger: Filter by specific charger UUID

Transaction Report Filters

• start_datetime__gte: Filter by start time (minimum)
• start_datetime__lte: Filter by start time (maximum)
• stop_datetime__gte: Filter by stop time (minimum)
• stop_datetime__lte: Filter by stop time (maximum)
• charger__