Analytics-Plus Help

Prerequisites

 

It is mandatory to use HTTPS in all API requests instead of HTTP request.

E.g. : https://<server_hostname>:<port_number>/api/as the API request URL.

 

The following are the prerequisites to use Analytics Plus API.

 

  • Analytics Plus User Account.

  • AuthToken.

  • Reporting Database. 



 

Analytics Plus User Account

 

Users should have a valid ManageEngine Analytics Plus login email address and password to use the API. If you do not have one, please contact your Analytics Plus administrator.



 

AuthToken

 

Authentication Token, also referred as AuthToken, is a unique token that authenticates the user to access his/her Analytics Plus Account. This is a permanent user specific token, that needs to be passed along with every Analytics Plus API request.

 

Generating AUTHTOKEN

 

Users can generate a AuthToken using one of the following modes. You can generate it just once and use it for all your API calls.

  • Browser Mode

  • API Mode

 

Browser Mode

 

To generate AuthToken from your browser, follow the steps given below.

  • Login to your Analytics Plus account.

  • Now open a new tab in the same browser and then access the url given in the sample


Browser Mode : URL

  • https://<server_hostname>:8200/apiauthtoken/create?SCOPE=ZROP/reportsapi

 

API MODE

To generate AuthToken using API mode, send an HTTPS POST request to Analytics Plus using the URL format given in the sample.

 

API Mode : URL

  • https://<server_hostname>:8200/apiauthtoken/nb/create?SCOPE=ZROP/reportsapi?EMAIL_ID=emailId&PASSWORD=password

 

 

MANDATORY "POST" PARAMETERS TO BE PASSED ALONG WITH THIS URL ARE: 

ParameterDescription
EMAIL_IDSpecify your Analytics Plus Login Email Address
PASSWORDSpecify your Analytics Plus Password
 
 

Sample Response:

The following is a sample response for a AuthToken request.

#

#Wed Jun 29 03:07:33 PST 2013

AUTHTOKEN=bad18eba1ff45jk7858b8ae88a77fa30

RESULT=TRUE

 

Response Details: 

  • * #-COMMENT AuthToken generated date.

  • * AUTHTOKEN The permanent AuthToken (Alpha numeric value) generated for Analytics Plus API access.

  • * RESULT Value is TRUE if the AuthToken is generated successfully.

 


 

MANAGING AuthTokenS

You can access and manage all the active secret AuthTokens of your Analytics Plus account from the Account Settings page.

 

TO ACCESS THE ACTIVE AuthTokenS:

Login to Analytics Plus.

  • Click the drop-down menu displayed with your user name at the top right corner.

  • Click the "My Account" menu item, this will open Analytics Plus Profile page.

  • Click on the edit icon to change the specified email id.
  • Navigate to the Sessions tab and then click Active Authtokens. The Active Authtoken page will list all the active secret AuthTokens of your account.

  • If required, you can remove the AuthToken using the Remove button.

 

IMPORTANT NOTE 

  • Generate a single AuthToken and use it across all API calls in Analytics Plus.

  • In case the user has removed or regenerated the AuthToken, then the existing token will become invalid and cannot be used in API request.

  • In case the user is deactivated, then all the AuthToken's of the user's account will become invalid.

 


 

Reporting Database

To use the Analytics Plus API, users should have already created a reporting database with required tables and reports in Analytics Plus. You cannot use the API, if you do not have any reporting databases in your Analytics Plus account.

To know how to create a database, click here.

Share this post : FacebookTwitter