NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Call Center/Statistics → Get Callqueue Statistics for All Queues by Queue

AI-generated

Summary

Retrieve callqueue statistics aggregated across all queues within a specified date range and domain.

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.
  • 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 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.
  • 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 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.
  • fields — Fields in order to fill and get particular statistics for. Separate multiple fields with ','. Default value is VOL,CH,ATT,AC,AWT,SL
  • remove_zeros — Remove zeros from the results
  • queue_list — Allows for a filter of certain queues. List can be comma separated for example 421,425

Output shape

an array of callqueue statistics objects, each containing fields such as VOL, CH, ATT, AC, AWT, SL

Results are returned per queue; pagination is not applicable; optional query parameters can filter or modify output; errors follow the standard API error envelope.

Examples

Example 1: Fetch statistics for all queues in a given domain between two dates

domain=example.com, datetime-start=2023-11-01T00:00:00Z, datetime-end=2023-11-30T23:59:59Z, fields=VOL,CH,ATT,AC,AWT,SL, remove_zeros=&queue_list=

Example 2: Filter statistics to a specific list of queues

domain=example.com, datetime-start=2023-10-01T00:00:00Z, datetime-end=2023-10-02T00:00:00Z, queue_list=421,425, fields=VOL,CH, remove_zeros=true, refreshOptions=true

Links

Discussion