Get Agent Responses based on filters

POST

/api/v2/agent-responses/dashboard

The Get Agent Responses based on filters API endpoint allows users to retrieve agent responses based on various filters.
This feature enables users to filter and retrieve specific agent responses based on criteria such as user, project, agent, date range, and more.

Query Parameters:

items_per_page (int): Number of items per page. Default is 50.

page (int): Page number. Default is 1.

Request Body:

user_ids (list): List of user IDs to filter by.

agent_ids (list): List of agent IDs to filter by.

project_ids (list): List of project IDs to filter by.

response_quality (str): Filter by response quality (upvote or downvote).

comments (bool): Filter by comments (True or False).

query_source (str): Filter by query source.

success_status (str): Filter by success status (successful or failed).

from_date (str): Filter by start date (YYYY-MM-DD).

to_date (str): Filter by end date (YYYY-MM-DD).

export (bool): Export the data to a CSV file. Default is False.

timezone (str): Timezone of the user. Default is UTC.

Returns:

A response containing the retrieved agent response objects.

Current Version:

2.1.0

Notes:

from_date/to_date accept either date (YYYY-MM-DD) or ISO 8601 datetime. Date-only uses start/end of day in user's timezone.

Optional 'duration' body field (e.g., 30m, 12h, 7d, 2w, 5s) applies when explicit dates are not provided.

Explicit timestamps take precedence over 'duration'.

2.1.0

Changelog:

2.1: Added artifacts field to response object for enhanced chatlog data

2.0: Initial version

Request

Query Params

Header Params

Body Params

application/json

Examples

Responses

🟢200OK

application/json

Successfully fetched Agent Response Dashboard List

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agent-responses/dashboard?items_per_page=&page=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "user_ids": [
        0
    ],
    "agent_ids": [
        0
    ],
    "project_ids": [
        0
    ],
    "export": true,
    "response_quality": "string",
    "comments": true,
    "query_source": "string",
    "success_status": "string",
    "from_date": "string",
    "to_date": "string",
    "timezone": "string",
    "duration": "string"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "count": 0,
        "num_pages": 0,
        "current_page": 0,
        "agent_responses": [
            {
                "id": 0,
                "comments": [
                    {
                        "id": 0,
                        "chat_log": 0,
                        "comment": "string",
                        "created_by": "string",
                        "created_on": "2019-08-24T14:15:22.123Z",
                        "created_on_modified": "string"
                    }
                ],
                "feedback": [
                    {
                        "id": 0,
                        "chat_log": 0,
                        "is_upvote": true,
                        "is_downvote": true,
                        "created_by": "string",
                        "created_on": "2019-08-24T14:15:22.123Z",
                        "modified_by": "string",
                        "modified_on": "2019-08-24T14:15:22.123Z",
                        "created_on_modified": "string"
                    }
                ],
                "agent": {
                    "id": 0,
                    "agent_name": "string",
                    "agent_type": {
                        "name": "string"
                    },
                    "created_by": "string",
                    "created_on": "2019-08-24T14:15:22.123Z",
                    "agent_image": "string",
                    "user": 0,
                    "project": 0
                },
                "question": "string",
                "response": {
                    "property1": "string",
                    "property2": "string"
                },
                "created_by": "string",
                "created_on": "2019-08-24T14:15:22.123Z",
                "created_on_modified": "string",
                "query_source": "string",
                "user": 0,
                "chat_thread": 0
            }
        ],
        "user_timezone": "string"
    }
}

Get Thoughts of an Agent Response

Get Agent Responses of an Agent