NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Call Center/Statistics → Get Agent Statistics for All Queues by Agent

AI-generated

Summary

Retrieve agent queue statistics for a specified domain and time range

Inputs

  • refreshOptions — Whether to bypass cached dropdown values and fetch fresh options
  • GetDomainsByStatisticsAgent__path__domain (required) — This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.
  • GetDomainsByStatisticsAgent__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 response using the same format.
  • GetDomainsByStatisticsAgent__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 response using the same format.
  • GetDomainsByStatisticsAgent__query__fields — Fields in order to fill and get particular statistics for. Separate multiple fields with "," Default value is NAME,CH,ATT,AHT,TT
  • GetDomainsByStatisticsAgent__query__department — This is the department that queue belongs to in the domain.
  • GetDomainsByStatisticsAgent__query__remove_zeros — Remove zeros from the results

Output shape

array of agent queue statistics objects

Each object contains the fields specified via the Fields parameter; default fields are NAME,CH,ATT,AHT,TT. Omitted fields are excluded. The response does not paginate.

Examples

Example 1: Fetch basic statistics for a domain over a week

Domain=example.com, Datetime Start=2023-09-01T00:00:00Z, Datetime End=2023-09-08T00:00:00Z, Fields=NAME,CH,ATT,AHT,TT, Refresh Dropdown Cache=false

Example 2: Include additional metrics and filter by department

Domain=example.com, Datetime Start=2023-01-01, Datetime End=2023-12-31, Fields=NAME,CH,ATT,AH,AHT,TT, Department=Support, Remove Zeros=true, Refresh Dropdown Cache=false

Example 3: Retrieve all available statistics without specifying fields

Domain=example.com, Datetime Start=2023-01-01, Datetime End=2023-12-31, Refresh Dropdown Cache=false

Links

Discussion