Retrieves aggregated employee statistics. Requires the call_center component.

Retrieves aggregated employee statistics. Requires the call_center component

Method	get.employee_stat
API version	—
Description	Retrieves aggregated employee statistics. Requires the call_center component.

Available to: Agents and clients

Request parameters

Name	Type	Required	Description
access_token	string	yes	Access token used to authenticate the request.
user_id	number	no	Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use "get.customer_users".
limit	number	no	Maximum number of records to return. See the "Paging" section.
offset	number	no	Number of records to skip before returning results. Default: 0. See the "Paging" section.
filter	object	no	Filtering criteria. See the "Filters" section.
fields	array	no	Fields to include in the response. See the "Viewing returned data" section.
sort	array	no	Sorting criteria. See the "Data sorting" section.
date_from	iso8601	yes	Start of the reporting period. Format: YYYY-MM-DD hh:mm:ss.
date_till	iso8601	yes	End of the reporting period. Format: YYYY-MM-DD hh:mm:ss.
only_default_statuses_in_stats	boolean	no	Whether to group statistics by standard status mnemonic. Default: true.

Response parameters

Name	Type	Valid values	Filtering	Sorting	Description
id	number		yes		Unique employee ID.
first_name	string		yes	yes	Employee's first name.
last_name	string		yes	yes	Employee's last name.
patronymic	string			yes	Employee's middle name.
full_name	string		yes	yes	Employee's full name: last name, first name, and middle name.
Employee status statistics
status_stats	object		yes		Time spent in each status, in seconds. Use get.statuses to retrieve statuses. If only_default_statuses_in_stats is true, keys are standard status mnemonics. If false, keys are status IDs, and deleted statuses are included when data exists for the selected period.
Employee groups
groups	array		yes		Groups the employee belongs to.
group_id	number				Unique employee group ID.
group_name	string				Employee group name.

Example request

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "get.employee_stat",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "offset": "number",
    "limit": "number",
    "date_from": "iso8601",
    "date_till": "iso8601",
    "filter": {},
    "sort": [
      {
        "field": "string",
        "order": "string"
      }
    ],
    "fields": [
      "string"
    ]
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {},
    "data": [
      {
        "id": "number",
        "first_name": "string",
        "last_name": "string",
        "patronymic": "string",
        "full_name": "string",
        "groups": [
          {
            "group_name": "string",
            "group_id": "number"
          }
        ],
        "status_stats": {
          "string": "number"
        }
      }
    ]
  }
}

Possible errors

See the "Errors for get methods" section.