Retrieve all evaluations or filter by dataset

GET

/api/v2/agents/{agent_id}/evaluations

Get all evaluations.

Path Parameters:

agent_id: ID of the agent to retrieve evaluations for

Query Parameters:

dataset_id: ID of the dataset to filter evaluations by

search: Search term to filter evaluations by name (case-insensitive substring match)

page: Page number for pagination (default: 1)

items_per_page: Number of items per page (default: 50)

sort_column: Column to sort by (evaluation_name, created_on, status, total_query_count)

sort_order: Sort order (ascending or descending)

Returns:
JSON response with paginated list of evaluations

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/agents//evaluations' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Success

{
    "success": true,
    "message": "Evaluations retrieved successfully",
    "data": {
        "count": 50,
        "num_pages": 5,
        "current_page": 1,
        "evaluations": [
            {
                "id": 31,
                "evaluation_name": "Test Evaluation",
                "total_query_count": 10,
                "status": "completed",
                "created_on": "2025-02-13T03:17:43.680874Z",
                "created_by": "admin@ejento.ai",
                "evaluation_dataset_info": []
            }
        ]
    }
}

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Evaluations successfully retrieved

Body

🔴500Server Error

Create a new Conversation Starter.

Create a new evaluation