JSON API » queues » queues/events/list

Gets the fields of queue events for a specified queue, or for all queues in a specified customer. These have only been collected if the queue or queues have been set to do so.

Input parameters

Requires authentication and the user role privilege if a queue is specified, or the administrator role privilege if a customer is specified.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
archive	Integer	1 to include archived entries, 0 not to.	No	0
customer	Integer	ID of customer to get events for all queues.	Yes, unless queue is specified.	None
queue	Integer	ID of queue to get events for.	Yes, unless customer is specified.	None
start	Integer	Start Unix timestamp. -1 for the last time this function was called for the queue or queues.	No	-1
end	Integer	End Unix timestamp. -1 for one second ago.	No	-1

If a customer and start=-1 are both specified, each queue uses its individual last time the function was called.

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 or customer 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 queue (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
4.0	archive input parameter added.
3.14	customer input parameter added.
3.13	Function added.