Skip to content

Reporting API

The Reporting API provides analytics, metrics, and dashboard data aggregation services.

Features

  • Dashboard Metrics - Real-time dashboard overview and statistics
  • Device Analytics - Comprehensive device performance metrics
  • Transaction Analysis - Transaction summaries and cost analysis
  • Custom Reports - Generate and download custom reports
  • Real-time Streaming - Server-sent events for live dashboard updates

Base URL

https://api.ampnexus.app/reporting/v1

API Reference

Explore the full API specification using the interactive Swagger UI below:

Quick Examples

Get Dashboard Overview

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.ampnexus.app/reporting/v1/tenants/{tenant_slug}/dashboard/overview

Get Device Metrics

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.ampnexus.app/reporting/v1/tenants/{tenant_slug}/metrics/devices

Generate Report

curl -X POST \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"report_type":"transaction_summary","date_from":"2025-01-01","date_to":"2025-01-31"}' \
  https://api.ampnexus.app/reporting/v1/tenants/{tenant_slug}/reports/generate