Get Agent Most Active Data

GET

/api/v2/analytics/agents/most-active

API endpoint for retrieving the most active agents based on engagement metrics.

Version:

2.1.0

Changelog:

v2.1.0: Added time series data support with bucket_type parameter

v2.0.0: New API version for most active agents data.

GET Parameters:

verbose (bool): Whether to include detailed statistics (default: false)
type (str): Query type ('fixed' or 'range')
days (int): Number of days to look back (for 'fixed' type)
start_date (str): Start date in ISO format (for 'range' type)
end_date (str): End date in ISO format (for 'range' type)
time_series (bool): Whether to return data in time series format
bucket_type (str): Type of time bucket ('day', 'week', 'month')
limit (int): Number of top entities to return per date bucket (default: 10)

Returns:

JSON response containing list of most active agents and their engagement metrics

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v2/analytics/agents/most-active' \
--header 'Ocp-Apim-Subscription-Key;'

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Agent most active  data retrieved successfully",
    "data": {
        "most_active_agents": [
            {
                "agent_name": "Customer Support Bot",
                "interaction_count": 500
            }
        ]
    }
}

Request

Authorization

API Key

Add parameter in header

Ocp-Apim-Subscription-Key

Example:

Ocp-Apim-Subscription-Key: ********************

Query Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠405405

🔴500Server Error

Get Agent Indexing Mode Data

Get Agent Query Count Data