NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Call Center/Statistics → Get Callqueue Statistics for a Specific Queue

AI-generated

Summary

Retrieve callqueue statistics for a specific queue given domain, callqueue, and date range

Inputs

  • refreshOptions — Whether to bypass cached dropdown values and fetch fresh options
  • GetDomainsByStatisticsCallqueuesBy__path__domain (required) — This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.
  • GetDomainsByStatisticsCallqueuesBy__path__callqueue (required) — When used in path the callqueue value will link to a extension id for a preconfigured callqueue.
  • GetDomainsByStatisticsCallqueuesBy__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 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]

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

Output shape

a list of callqueue statistics records

Each record contains the requested fields; optional fields may be omitted; results are returned as-is

Examples

Example 1: Fetch statistics for queue 5201 in domain example.com from 2023-01-01 to 2023-01-31 for fields VOL,CH

Domain = example.com, Callqueue = 5201, Datetime Start = 2023-01-01T00:00:00Z, Datetime End = 2023-01-31T23:59:59Z, Fields = VOL,CH, Refresh Dropdown Cache = false

Example 2: Retrieve aggregated statistics across all queues for a domain over the last 24 hours

Domain = example.com, Datetime Start = now-24h, Datetime End = now, Fields = VOL,CH, Remove Zeros = true

Example 3: Get real‑time stats for a specific callqueue with optional queue list filter

Domain = example.com, Callqueue = 5202, Datetime Start = current timestamp minus 1 hour, Datetime End = current timestamp, Queue List = 5202,5201, Refresh Dropdown Cache = true

Links

Discussion