COcontextualai
/agents/{id}/query

Get Metrics

Changed on

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

get/agents/{agent_id}/metrics

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/agents/{agent_id}/metrics
  • Auth
    HTTP bearer

Path parameters

agent_idstring uuid required

Agent ID of the agent to get metrics for

Query parameters

conversation_idsstring[]

Filter messages by conversation ids.

user_emailsstring[]

Filter messages by users.

created_afterstring date-time

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.

limitinteger

Limits the number of messages to return.

offsetinteger

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.

Changes

  • 194878b194cdRevision changes
    • info

      added the new optional query request parameter conversation_ids

    • info

      added the new optional query request parameter user_emails

  • 448bcb901d30Revision changes
    • info

      api operation id get_metrics_for_an_agent_agents__agent_id__metrics_get removed and replaced with Get_Metrics_agents__agent_id__metrics_get