JSON API » queues » queues/events/list

Gets the fields of queue events. These have only been collected if the queue is set to do so.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
queue	Integer	ID of queue to get events for.	Yes
start	Integer	Start Unix timestamp. -1 for the last time this function was called for this queue.	No	-1
end	Integer	End Unix timestamp. -1 for one second ago.	No	-1

Responses

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

Data returned

An array of fields, corresponding to the recorded queue events.

Example: With required parameters (data truncated for brevity)

http://enswitch.example.com/api/json/queues/events/list/?auth_username=user;auth_password=password;queue=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "data":"1234567890|NONE|..." }, { "data":"1234567891|NONE|..." } ] }

Change history

Version	Changes
3.13	Function added.