NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Call Center/Statistics → Get Agent Log

AI-generated

Summary

Fetch agent log statistics for a domain within a specified time window.

Inputs

  • refreshOptions — Whether to bypass cached dropdown values and fetch fresh options
  • domain (required) — This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.
  • GetDomainsByStatisticsAgentLog__query__datetime-start (required) — This is the start of the time window for a given query. The format is based on RFC3339 but also will support additional 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]

  • GetDomainsByStatisticsAgentLog__query__datetime-end (required) — This is the end of the time window for a given query. The format is based on RFC3339 but also will support additional 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.
  • GetDomainsByStatisticsAgentLog__query__fields — 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.
  • GetDomainsByStatisticsAgentLog__query__remove_zeros — Remove zeros from the results.
  • GetDomainsByStatisticsAgentLog__query__department — This is the department 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.

Output shape

a list of agent log statistics records

The response contains the requested fields; if remove_zeros is set the results will have zero values omitted. No pagination is indicated.

Examples

Example 1: Get agent log statistics for domain example.com from 2023-11-01 to 2023-11-30

domain=example.com, datetime-start=2023-11-01T00:00:00Z, datetime-end=2023-11-30T23:59:59Z, fields=AM,UM,L,B, remove_zeros=false

Example 2: Retrieve statistics with department filter and zero removal

domain=example.com, datetime-start=2023-10-01T00:00:00-05:00[America/Chicago], datetime-end=2023-10-31T23:59:59-05:00[America/Chicago], department=Support, remove_zeros=true

Links

Discussion