Statistics Reporting Services APIs
Learn about the purpose, structure, and capabilities of the Statistics Reporting Services API.
The Statistics Reporting Service provides comprehensive visibility into tenant level operational metrics through a set of RESTful APIs. It acts as a centralized data access layer that aggregates and exposes real time and historical performance data from multiple sources. The insights returned by these APIs can be used to identify performance bottlenecks, optimize system resources, and ensure adherence to service level objectives.
The APIs are designed to support monitoring of key operational indicators such as API performance, resource usage, and system reliability. The APIs are designed for the following roles:
| Role | Description |
|---|---|
| Integrates Reltio metrics into external systems | |
| Automates job execution or monitoring |
Purpose and use cases
The Statistics Reporting Services APIs support use cases across performance monitoring, queue analysis, and operational health reporting.
- API Performance Metrics: Retrieve latency statistics, most used and most time consuming APIs, failed requests (by endpoint or status), and usage patterns of active users.
- Queue Monitoring: Access detailed queue metrics including size, processing speed, failure counts, and minimum or maximum time in queue to assess system throughput and identify potential backlogs.
- Operational Health Reporting: Gain visibility into API success and failure rates, event streaming performance, and daily task usage to support operational dashboards and alerting systems.
Supported Statistics Reporting APIs
The following table lists all APIs documented under Statistics Reporting Services. Each entry includes the endpoint, method, summary, and a link to the detailed topic.
| API | Method | Description | See topic |
|---|---|---|---|
| /statistics-reporting/{tenantId}/API/latencyStats/_byInterval | POST | Aggregated API metrics by filter and time interval | Retrieve API metrics grouped by factor and time interval |
| /statistics-reporting/{tenantId}/API/getMostUsedApis | POST | Returns API usage statistics for the most frequently called endpoints | Retrieve most used API endpoints |
| /statistics-reporting/{tenantId}/API/getMostTimeConsumingApis | POST | Returns API endpoints with the highest execution time during the specified time period | Retrieve most time-consuming API endpoints |
| /statistics-reporting/{tenantId}/API/getMostActiveUsers | POST | API usage statistics per user | Retrieve most active users |
| /statistics-reporting/{tenantId}/API/failedRequestsByEndpoint | POST | Failed request counts by endpoint and status | Retrieve failed API requests by endpoint |
| /statistics-reporting/{tenantId}/API/failedRequestsByStatus | POST | Failed request totals grouped by HTTP status | Retrieve failed API requests by status code |
| /statistics-reporting/{tenantId}/API/getFailedRequests | POST | Timestamped records of failed requests with metadata | Retrieve detailed failed API requests |
| /statistics-reporting/{tenantId}/API/getDailyTaskUsage | POST | Daily task totals (success, failed) | Retrieve daily task usage summary |
| /statistics-reporting/{tenantId}/API/eventStreamingProcessor/sentMessages | POST | Messages sent by Event Streaming Processor | Retrieve messages sent by Event Streaming Processor |
| /statistics-reporting/{tenantId}/API/queueMetrics/queueSize | POST | Queue size at regular intervals | Retrieve queue size metrics by time interval |
| /statistics-reporting/{tenantId}/API/queueMetrics/queueProcessingSpeed | POST | Messages processed per topic over time | Retrieve queue processing speed by time interval |
| /statistics-reporting/{tenantId}/API/queueMetrics/failedMessages | POST | Failed messages per topic and time interval | Retrieve failed queue messages by time interval |
| /statistics-reporting/{tenantId}/API/queueMetrics/deadLetterQueueSize | POST | Dead-letter queue size by topic and interval | Retrieve dead-letter queue size by time interval |
| /statistics-reporting/{tenantId}/API/queueMetrics/minTimeInQueue | POST | Minimum time messages spent in queue per interval | Retrieve minimum queue dwell time by interval |
| /statistics-reporting/{tenantId}/API/queueMetrics/maxTimeInQueue | POST | Maximum time messages spent in queue per interval | Retrieve maximum queue dwell time by interval |
| /statistics-reporting/{tenantId}/API/queueMetrics/avgTimeInQueue | POST | Average dwell time of messages in queue per interval | Retrieve average queue dwell time by interval |
| /statistics-reporting/{tenantId}/API/queueMetrics/totalEvents | POST | Total event counts by topic and interval | Retrieve total event counts by time interval |