JSON API » analytics » analytics/get

Gets the fields of an analytics report, and/or the features to be reported on.

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
id	Integer	ID of report to get.	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

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/get/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "name":"example", ... } }

Change history

Version	Changes
4.3	Function added.