Get Projects based on filters

GET

/api/v2/projects/filter

Retrieves a list of projects that match the provided filter criteria, enabling users to narrow down results based on agents, users, or a specific date range.

Query Parameters:

start_date (str): ISO format date (optional, defaults to 30 days ago)

end_date (str): ISO format date (optional, defaults to current date)

user_ids (list): comma-separated list of user IDs (optional)

agent_ids (list): comma-separated list of agent IDs (optional)

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

comments (optional): Filter by comments (true or false).

query_source (optional): Filter by query source.

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

timezone (optional): Timezone string (optional, defaults to UTC).

Returns:

A response containing the filtered projects.

Current Version:

2.0.0

Request

Query Params

Header Params

Responses

🟢200OK

application/json

The projects of the project

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/projects/filter?agent_ids=&comments=&end_date=&query_source=&response_quality=&start_date=&success_status=&timezone=&user_ids=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "projects": [
            {
                "id": 0,
                "project_name": "string",
                "created_by": "string",
                "team": 0
            }
        ]
    }
}

Get multiple Projects by their IDs

Get Recent Projects for a User