Skip to main content

Analytics Service – API Reference 📊

This document describes the read-only analytics APIs exposed by the Analytics Service in ShopVerse.

These APIs provide business insights and metrics derived from event-driven data pipelines and are accessible only to administrators.

🌐 Base URL​


/api/analytics

🔐 Authentication & Authorization​

  • JWT is validated at the API Gateway
  • Gateway injects:
    • X-User-Email
    • X-User-Role
  • Only users with ADMIN role can access analytics APIs
  • Analytics data is never exposed to customers

📈 Dashboard Metrics​

Fetch high-level business metrics for dashboards.

➤ Endpoint​


GET /api/analytics/dashboard

➤ Role Required​


ADMIN

➤ Success Response (200 OK)​

{
  "totalUsers": 1250,
  "totalOrders": 340,
  "totalRevenue": 845000,
  "ordersToday": 12
}

💰 Revenue Analytics​

Fetch revenue-related statistics.

➤ Endpoint​

GET /api/analytics/revenue

➤ Role Required​

ADMIN

➤ Query Parameters (Optional)​

ParamDescription
fromStart date (YYYY-MM-DD)
toEnd date (YYYY-MM-DD)

➤ Success Response (200 OK)​

{
  "dailyRevenue": [
    {
      "date": "2026-01-20",
      "amount": 125000
    },
    {
      "date": "2026-01-21",
      "amount": 98000
    }
  ]
}

📦 Order Analytics​

Fetch order statistics.

➤ Endpoint​

GET /api/analytics/orders

➤ Role Required​

ADMIN

➤ Success Response (200 OK)​

{
  "totalOrders": 340,
  "ordersByStatus": {
    "CREATED": 25,
    "CONFIRMED": 300,
    "CANCELLED": 15
  }
}

📡 Data Source​

Analytics APIs query data processed through:

Kafka → Apache Flink → ClickHouse
  • Kafka stores raw events
  • Flink aggregates & transforms
  • ClickHouse serves fast analytical queries

🔄 Request Flow​

⚠️ Common Errors​

StatusMeaning
401Unauthorized
403Forbidden
500Analytics query failure

🛡️ Security Notes​

  • Analytics endpoints are read-only
  • No sensitive user data exposed
  • Access strictly limited to admins
  • Queries are optimized for performance

📌 Summary​

The Analytics API provides:

  • Real-time business insights
  • Secure, admin-only access
  • High-performance analytical queries
  • Event-driven data accuracy

It enables data-driven decision making in ShopVerse.