> ## Documentation Index
> Fetch the complete documentation index at: https://docs.convocore.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Get All Metrics Data
> Retrieve aggregated data for all custom metrics in a single request
## 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:
```javascript theme={null}
// Single request for all metrics
const allMetrics = await fetch(
`/v3/agents/{agentId}/custom-metrics/data?startTs=${startTs}&endTs=${endTs}`
);
```
## Response Format
Returns an array with aggregated data for each metric:
```json theme={null}
{
"success": true,
"data": [
{
"key": "customer_satisfaction",
"type": "numeric",
"average": 8.5,
"sum": 425,
"min": 5,
"max": 10,
"totalDataPoints": 50
},
{
"key": "sentiment",
"type": "categorical",
"counts": {
"positive": 30,
"negative": 10,
"neutral": 10
},
"totalDataPoints": 50
},
{
"key": "issue_resolved",
"type": "categorical",
"counts": {
"true": 45,
"false": 5
},
"totalDataPoints": 50
}
]
}
```
## Time-Series Control
By default, time-series data is **not included** to keep responses lightweight. Enable it when needed:
```
GET /v3/agents/{agentId}/custom-metrics/data?startTs=1640000000&endTs=1640100000&includeTimeSeries=true
```
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:
```javascript theme={null}
// Fetch all metrics for today
const today = new Date();
today.setHours(0, 0, 0, 0);
const startTs = Math.floor(today.getTime() / 1000);
const endTs = Math.floor(Date.now() / 1000);
const dashboardData = await fetch(
`/v3/agents/{agentId}/custom-metrics/data?startTs=${startTs}&endTs=${endTs}`
);
// Display each metric in dashboard cards
dashboardData.data.forEach(metric => {
if (metric.type === 'numeric') {
displayNumericCard(metric.key, metric.average, metric.sum);
} else {
displayCategoricalChart(metric.key, metric.counts);
}
});
```
### Weekly Reports
Generate comprehensive weekly performance reports:
```javascript theme={null}
const now = Math.floor(Date.now() / 1000);
const weekAgo = now - (7 * 24 * 60 * 60);
const weeklyReport = await fetch(
`/v3/agents/{agentId}/custom-metrics/data?startTs=${weekAgo}&endTs=${now}`
);
// Generate PDF or email report
generateWeeklyReport(weeklyReport.data);
```
### Comparative Analysis
Compare multiple metrics side-by-side:
```javascript theme={null}
const metricsData = await fetchAllMetrics();
// Find correlations between metrics
const satisfaction = metricsData.find(m => m.key === 'customer_satisfaction');
const resolution = metricsData.find(m => m.key === 'issue_resolved');
analyzeCorrelation(satisfaction, resolution);
```
## 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:
```json theme={null}
{
"success": true,
"data": []
}
```
## Integration Example
```typescript theme={null}
// TypeScript example
interface MetricData {
key: string;
type: 'numeric' | 'categorical';
average?: number;
sum?: number;
min?: number;
max?: number;
counts?: Record;
totalDataPoints: number;
}
async function fetchAgentMetrics(
agentId: string,
startTs: number,
endTs: number
): Promise {
const response = await fetch(
`/v3/agents/${agentId}/custom-metrics/data?startTs=${startTs}&endTs=${endTs}`,
{
headers: {
'Authorization': `Bearer ${API_KEY}`
}
}
);
const result = await response.json();
return result.data;
}
```
## OpenAPI
````yaml GET /agents/{agentId}/custom-metrics/data
openapi: 3.0.3
info:
title: Convocore API - Custom Metrics
description: >-
Custom Metrics API endpoints for tracking and analyzing agent-specific
metrics
version: 1.0.4
servers:
- url: https://eu-gcp-api.vg-stuff.com/v3
description: EU Production server
- url: https://na-gcp-api.vg-stuff.com/v3
description: NA Production server
security: []
paths:
/agents/{agentId}/custom-metrics/data:
get:
tags:
- Custom Metrics
summary: Get all metrics data and aggregations
description: >-
Retrieves aggregated data for all metrics within a time range. Returns
averages and sums for numeric metrics, and counts for categorical
metrics.
operationId: customMetrics-getAllMetricsData
parameters:
- name: agentId
in: path
required: true
schema:
type: string
description: The unique identifier of the agent
- name: startTs
in: query
required: true
schema:
type: number
description: Start timestamp (Unix timestamp in seconds)
- name: endTs
in: query
required: true
schema:
type: number
description: End timestamp (Unix timestamp in seconds)
- name: includeTimeSeries
in: query
required: false
schema:
type: boolean
default: false
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: array
items:
type: object
properties:
key:
type: string
type:
anyOf:
- type: string
enum:
- numeric
- type: string
enum:
- categorical
average:
type: number
sum:
type: number
min:
type: number
max:
type: number
counts:
type: object
additionalProperties:
type: number
timeSeries:
type: array
items:
type: object
properties:
ts:
type: number
value:
anyOf:
- type: string
- type: number
- type: boolean
convo_id:
type: string
required:
- ts
- value
- convo_id
additionalProperties: false
totalDataPoints:
type: number
required:
- key
- type
- totalDataPoints
additionalProperties: false
required:
- success
- data
additionalProperties: false
default:
$ref: '#/components/responses/error'
security:
- Authorization: []
components:
responses:
error:
description: Error response
content:
application/json:
schema:
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
securitySchemes:
Authorization:
type: http
scheme: bearer
````