JSON API » queues » queues/statistics/get

Gets call statistics for a queue.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
queueIntegerID of queue to get statistics for.Yes
startIntegerStart Unix timestamp.Recommended0
endIntegerEnd Unix timestamp.RecommendedNow.

Failure to specify the start and end may put a heavy load on the database.

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The queue does not exist, or you do not have permission to view it.

Data returned

Fields of statistics.

Example: With required and recommended parameters

http://enswitch.example.com/api/json/queues/statistics/get/?auth_username=user;auth_password=password;id=123;start=1230000000;end=1240000000

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "calls":10, "calls_answered":8, ... } }

Change history

VersionChanges
3.13Function added.