Analytics-Plus Help

ManageEngine Analytics Plus API

 

ManageEngine Analytics Plus API offers wide range of functions to help developers build & manage powerful reporting and analytical capabilities for their business application needs. You can add powerful business intelligence capabilities to your product/application, build add-ons to analyze data from third-party business applications.

Easy to use programming language wrappers called "Client Libraries" are provided to conveniently use the Analytics Plus API from within your familiar programming language like Java, C#, Python, PHP, GO and Google Apps. 

Infact ManageEngine Analytics Plus API allows you to:

  • Add data into a table in ManageEngine Analytics Plus database

  • Modify data in the ManageEngine Analytics Plus database

  • Bulk Add/Update data into a table via CSV file.

  • Bulk Update with criteria support.

  • Bulk Delete with criteria support.

  • Export data and Reports in various formats such as CSV, JSON, PDF,HTML,IMAGE

  • Fetch data from the database using SQL Select query.

 

Prerequisites

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

Always use https://<server_hostname>:8443/api as the API request URL.

The following are the prerequisites to use Analytics Plus API.

  • Analytics Plus User Account.

  • AuthToken.

  • workspace. 

 

 

Auth Token

Authentication Token, also referred as Auth Token, 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 AUTH TOKEN

 

Users can generate a Auth Token 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 Auth Token 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

 

API MODE

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

 

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

ParameterDescription
Email addressSpecify your registered email address with ManageEngine Analytics Plus
Database nameSpecify the name of the database
 
 

THE FOLLOWING ARE THE STEPS TO GENERATE AN APPLICATION SPECIFIC PASSWORD FOR YOUR ManageEngine ACCOUNT.

  • Login into Analytics Plus.

  • Click Manage Application Specific Passwords button.

  • Specify a descriptive name in Device (or) App Name field. For example Analytics Plus API. The Device (or) App Name is only for your reference.

  • Specify your Analytics Plus Password.

  • Click Generate. The Application Specific Password will be generated.

  • Use this Application Specific Password to generate the Auth Token for your account. Click here to learn more about Application Specific Passwords.

 

MANAGING AUTH TOKENS

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

 

TO ACCESS THE ACTIVE AUTH TOKENS:

  • Login to Analytics Plus.

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

  • Click Account Settings menu item, this will open Analuytics Plus Profile page.

  • Navigate to the Settings tab and then click Active Authtokens. The Active Authtoken page will list all the active secret Auth Token of your account.

  • If required, you can remove or regenerate the Auth Token using the Remove and Re-Generate button respectively.

 

IMPORTANT NOTE 

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

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

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

 

workspace 

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

Share this post : FacebookTwitter