JSON API » analytics » analytics/data

Gets the data to populate an analytics report.

Input parameters

Requires authentication and the administrator privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
end	Integer	Unix timestamp for end of data period to return.	No	Time of request
first	Integer	1 if this is the first data request for a report being run, 0 for subsequent requests.	No	0
queueevents	Integer	1 if any metrics for queues are enabled, 0 if not.	No	0
recursive	Integer	1 to include sub-customers recursively, 0 not to.	No	0
refresh	Integer	The report refresh time interval in seconds.	No	2
start	Integer	Unix timestamp for start of data period to return.	No	Time of request

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The report does not exist.

Data returned

Fields of report.

Example:

http://enswitch.example.com/api/json/analytics/data/?auth_username=user;auth_password=password;start=123456789

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], {"data": {"cdrs_columns":[ "id","callid","start","answered","end","callerid_internal","stype","snumber","ctype","cnumber","dtype","dnumber","holdtime","talktime","totaltime","queuestatus","cost","symbol"], "phones": ... } }

Change history

Version	Changes
4.3	Function added.