v21

latestOpenAPI 3.1.0raw.githubusercontent.com2026-01-1340148239.5 KB
/agents/{id}/query

Get Metrics

Returns usage and user-provided feedback data. This information can be used for data-driven improvements and optimization.

get/agents/{agent_id}/metrics

Path parameters

agent_idstring uuid required

Agent ID of the agent to get metrics for

Agent ID of the agent to get metrics for

Query parameters

conversation_idsstring[]

Filter messages by conversation ids.

Filter messages by conversation ids.

user_emailsstring[]

Filter messages by users.

Filter messages by users.

created_afterstring date-time

Filters messages that are created after the specified timestamp.

Filters messages that are created after the specified timestamp.

created_beforestring date-time

Filters messages that are created before specified timestamp. If both created_after and created_before are not provided, then created_before will be set to the current time and created_after will be set to the created_before - 2 days. If only created_after is provided, then created_before will be set to the created_after + 2 days. If only created_before is provided, then created_after will be set to the created_before - 2 days. If both created_after and created_before are provided, and the difference between them is more than 2 days, then created_after will be set to the created_before - 2 days.

Filters messages that are created before specified timestamp. If both created_after and created_before are not provided, then created_before will be set to the current time and created_after will be set to the created_before - 2 days. If only created_after is provided, then created_before will be set to the created_after + 2 days. If only created_before is provided, then created_after will be set to the created_before - 2 days. If both created_after and created_before are provided, and the difference between them is more than 2 days, then created_after will be set to the created_before - 2 days.

limitinteger

Limits the number of messages to return.

Limits the number of messages to return.

offsetinteger

Offset for pagination.

Offset for pagination.

Response

Successful Response

total_countinteger required

Total number of messages.

next_offsetinteger

Offset for the next page. If there are no more messages to get, then this is not set.