Skip to main content
GET
/
agents
/
{agent_id}
/
metrics
Get Metrics
curl --request GET \
  --url https://api.contextual.ai/v1/agents/{agent_id}/metrics \
  --header 'Authorization: Bearer <token>'
{
  "total_count": 123,
  "messages": [],
  "next_offset": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_id
string<uuid>
required

Agent ID of the agent to get metrics for Agent ID of the agent to get metrics for

Query Parameters

​
conversation_ids
string<uuid>[]

Filter messages by conversation ids. Filter messages by conversation ids.

​
user_emails
string[]

Filter messages by users. Filter messages by users.

​
created_after
string<date-time>

Filters messages that are created after the specified timestamp. Filters messages that are created after the specified timestamp.

​
created_before
string<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.

​
limit
integer
default:100

Limits the number of messages to return. Limits the number of messages to return.

Required range: x <= 1000
​
offset
integer
default:0

Offset for pagination. Offset for pagination.

Response

Successful Response

​
total_count
integer
required

Total number of messages.

​
messages
any[]

List of messages.

​
next_offset
integer

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