Manage Agents
Agent Statistics
Agent Statistic API
Description
This API endpoint is used to retrieve agent statistics for a specified period.
Request Body
-
start_time (text, Required): Beginning time of the period (Y-m-d H:00:00)
-
format (text): The format of the response
-
agent_ids (text): Search by agent id, example 1 || 1,2,3...
-
desk_ids (text): Search by desk id, example 1 || 1,2,3...
-
end_time (text): End time of the period, default current date time (Y-m-d H:00:00)
Response
The response for this request is a JSON object with the following properties:
-
success (string): Indicates the success status of the request
-
message (string): Provides additional information or error message
Response JSON Schema
{
"type": "object",
"properties": {
"success": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
post/api/AgentStatistic
Request
- Base URLhttps://your-instance.stats.pbx.commpeak.com
- URLhttps://your-instance.stats.pbx.commpeak.com/api/AgentStatistic
- AuthAPI key in header X-API-KEY
Request body application/x-www-form-urlencoded
Example request
{
"agent_ids": "<string>",
"desk_ids": "<string>",
"end_time": "<dateTime>",
"format": "json",
"start_time": "<dateTime>"
}Response
successful
Example response
{
"message": "<string>",
"success": "<boolean>"
}Changes
No recorded changes to this operation across all 1 revision of this API.