Get Aggregated Analytics
GET /api/analytics/
Aggregated analytics from all real data sources.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Time range for analytics
Time range for analytics
Responses
Section titled “ Responses ”Successful Response
Combined analytics response for dashboard.
Comprehensive analytics payload aggregating all analytics data sources including performance, usage, agent metrics, errors, time series, endpoints, and module usage for complete dashboard visualization.
Fields: performance: Performance metrics (CPU, memory, disk, network, response time) usage: Usage metrics (users, sessions, API calls, documents, conversations) agents: Agent metrics (requests, response time, success rate, active agents) errors: Error metrics (total, rate, critical, resolved) time_series: Time series data for trend charts top_endpoints: List of top endpoints by request volume module_usage: List of module usage statistics time_range: Time range for analytics (hour, day, week, month, year) health_score: Overall system health score (0-100) productivity_score: Overall productivity score (0-100) last_update: Last update timestamp (ISO 8601)
Used By: - GET /api/analytics/ endpoint - Analytics dashboard main view - System health overview
object
Performance metrics
object
CPU usage percentage
Memory usage percentage
Disk usage percentage
Network latency in ms
Average response time in ms
Usage metrics
object
Active users count
Total sessions count
Average session duration in seconds
API calls count
Documents created count
Conversations started count
Agent metrics
object
Total agent requests
Average response time in ms
Success rate percentage
Active agents count
Agent collaborations count
Error metrics
object
Total errors count
Error rate percentage
Critical errors count
Resolved errors count
Time series metrics
object
CPU usage time series
Time series data point for analytics charts.
Represents a single data point in time series analytics with timestamp, value, and optional label for chart visualization.
Fields: timestamp: Unix timestamp in milliseconds value: Data point value label: Optional label for the data point
Used By: - AnalyticsTimeSeriesMetrics model - Analytics dashboard time series charts - Trend visualization
Memory usage time series
Time series data point for analytics charts.
Represents a single data point in time series analytics with timestamp, value, and optional label for chart visualization.
Fields: timestamp: Unix timestamp in milliseconds value: Data point value label: Optional label for the data point
Used By: - AnalyticsTimeSeriesMetrics model - Analytics dashboard time series charts - Trend visualization
API calls time series
Time series data point for analytics charts.
Represents a single data point in time series analytics with timestamp, value, and optional label for chart visualization.
Fields: timestamp: Unix timestamp in milliseconds value: Data point value label: Optional label for the data point
Used By: - AnalyticsTimeSeriesMetrics model - Analytics dashboard time series charts - Trend visualization
Agent requests time series
Time series data point for analytics charts.
Represents a single data point in time series analytics with timestamp, value, and optional label for chart visualization.
Fields: timestamp: Unix timestamp in milliseconds value: Data point value label: Optional label for the data point
Used By: - AnalyticsTimeSeriesMetrics model - Analytics dashboard time series charts - Trend visualization
Error rate time series
Time series data point for analytics charts.
Represents a single data point in time series analytics with timestamp, value, and optional label for chart visualization.
Fields: timestamp: Unix timestamp in milliseconds value: Data point value label: Optional label for the data point
Used By: - AnalyticsTimeSeriesMetrics model - Analytics dashboard time series charts - Trend visualization
Top endpoints list
Top endpoint statistics for analytics dashboard.
Represents a single endpoint’s performance metrics for endpoint ranking and API performance analysis.
Fields: endpoint: Endpoint path requests: Request count for endpoint average_response_time: Average response time in milliseconds error_rate: Error rate percentage for endpoint
Used By: - GET /api/analytics/ endpoint - Analytics dashboard top endpoints section - API performance analysis
object
Endpoint path
Request count
Average response time in ms
Error rate percentage
Module usage list
Module usage statistics for analytics dashboard.
Tracks individual module usage metrics including usage count, time spent, and engagement scores for module performance analysis.
Fields: module: Module name usage: Usage count time_spent: Time spent in seconds engagement_score: Engagement score (0-100)
Used By: - GET /api/analytics/ endpoint - Analytics dashboard module usage section - User engagement analysis
object
Module name
Usage count
Time spent in seconds
Engagement score
Time range for analytics
Overall health score
Overall productivity score
Last update timestamp (ISO 8601)
Validation Error