NSns-api
Call Center/Statistics

Get Agent Log

Changed on
get/domains/{domain}/statistics/agentLog

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/statistics/agentLog
  • Auth
    HTTP bearer

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.

Query parameters

datetime-startstring rfc3339 required

This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.

Supported formats include.

  • 2023-11-27 13:00:00
  • 2023-11-27T13:00:00Z
  • 2023-11-27T13:00:00-08:00
  • 2023-11-27T13:00:00-08:00[US/Pacific]
  • 2023-11-27T13:00:00Z[America/Phoenix]

This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.

Supported formats include.

2023-11-27 13:00:00 2023-11-27T13:00:00Z 2023-11-27T13:00:00-08:00 2023-11-27T13:00:00-08:00[US/Pacific] 2023-11-27T13:00:00Z[America/Phoenix]

datetime-endstring rfc3339 required

This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.

This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.

fieldsstring

Fields in order to fill and get particular statistics for. Separate multiple fields with ",".Default value is AM,UM,L,B. For custom status use CUST1 to CUST8.

remove_zerosstring

Remove zeros from the results.

departmentstring

This is the depertment that user belongs to in the domain. Can be any string to group users, a department is not require to be setup before in order to set it for a user.

Response

status-login-duration-minutesnumber

This is the total time the call center agent's status was set to "online". Starting in v43.2, an agent has to manually change their status from offline to online when they begin their shift; logging into the portal no longer affects the LI stat.

status-available-duration-minutesnumber

This is the total time the call center agent was available for calls. This includes time logged in / online. It excludes statuses of unavailable such as break, lunch, meeting, web, and other.

status-unavailable-duration-minutesnumber

This is the total time the call center agent was not available for calls. Includes time agent has the offline statuses, such as offline, break, lunch, meeting, web, and other. Excludes online / available.

status-lunch-duration-minutesnumber

This is the total time the call center agent's status was set to "lunch".

status-break-duration-minutesnumber

This is the total time the call center agent's status was set to "break".

status-meeting-duration-minutesnumber

This is the total time the call center agent's status was set to "meeting".

status-other-duration-minutesnumber

This is the total time the call center agent's status is not set to available, break, lunch, meeting, or web. Excludes unavailable status.

status-web-duration-minutesnumber

This is the total time the call center agent's status was set to "web".

status-custom1-duration-minutesnumber

This is the total time the call center agent's status was set to "CUST1".

status-custom2-duration-minutesnumber

This is the total time the call center agent's status was set to "CUST2".

status-custom3-duration-minutesnumber

This is the total time the call center agent's status was set to "CUST3".

status-custom4-duration-minutesnumber

This is the total time the call center agent's status was set to "CUST4".

status-custom5-duration-minutesnumber

This is the total time the call center agent's status was set to "CUST5".

status-custom6-duration-minutesnumber

This is the total time the call center agent's status was set to "CUST6".

status-custom7-duration-minutesnumber

This is the total time the call center agent's status was set to "CUST7".

status-custom8-duration-minutesnumber

This is the total time the call center agent's status was set to "CUST8".

Changes