custom_metrics_read
Read the custom analytics metrics of an agent (values the AI extracts from each conversation or call, e.g. customer_satisfaction, booked_meeting). Actions: list, get (metricId), data (aggregated values for one metricKey in a time range: averages/sums for numbers, counts for boolean/enum/string), all_data (same for every metric). Time range defaults to the last 30 days; startTs/endTs are unix seconds. includeTimeSeries adds per-day points.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"action": "<action>",
"agentId": "<agentId>"
},
"name": "custom_metrics_read"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | compact (default) = light mode: long text is cut and bulky blobs are replaced by a size marker. full = complete API response. | |
| endTs | No | Unix seconds. Default: now. | |
| limit | No | For list. Default 50, max 100. | |
| action | Yes | ||
| agentId | Yes | ||
| startTs | No | Unix seconds. Default: 30 days ago. | |
| metricId | No | Required for get. | |
| metricKey | No | Required for data (the metric key, not its id). | |
| startAfterId | No | For list pagination. | |
| includeTimeSeries | No |