Skip to main content

Overview

Fetches aggregated analytics data for all metrics of an agent within a specified time range. This endpoint is ideal for dashboard overviews and comprehensive reporting.

Bulk Analytics

Instead of making individual requests for each metric, get all metric data at once:

Response Format

Returns an array with aggregated data for each metric:

Time-Series Control

By default, time-series data is not included to keep responses lightweight. Enable it when needed:
Setting includeTimeSeries: true significantly increases response size. Only enable when you need individual data points for each metric.

Use Cases

Dashboard Overview

Perfect for displaying all KPIs in a single dashboard view:

Weekly Reports

Generate comprehensive weekly performance reports:

Comparative Analysis

Compare multiple metrics side-by-side:

Performance Considerations

Optimization Tips:
  • Keep time ranges reasonable (7-30 days for routine queries)
  • Cache results for frequently accessed date ranges
  • Use pagination if you have many metrics (50+)
  • Set includeTimeSeries: false unless you specifically need it
  • Schedule large historical queries during off-peak hours

Response Size

Response size varies based on:
  • Number of configured metrics
  • Time range (more data points = larger response)
  • includeTimeSeries setting
  • Complexity of categorical distributions
Typical sizes:
  • 10 metrics, 24 hours, no time-series: ~5-10 KB
  • 20 metrics, 7 days, no time-series: ~15-30 KB
  • 20 metrics, 7 days, with time-series: ~500 KB - 2 MB

Empty Results

When no data exists for any metrics in the time range:

Integration Example