This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Page Comparison - Quick Start Guide (v.7 vs v.8) - API Manager 1.10.0 - WSO2 Documentation

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Click the APIs menu in the API Store and then click on the API that you want to invoke. When the API opens, go to its API Console tab.

  2. Expand the GET method of the resource CheckPhoneNumber. Note the parameters that you added when creating the interactive documentation now appear with their descriptions so that as a subscriber, you know how to invoke this API. 

  3. Give sample values for the PhoneNumber and LicenseKey and click Try it out to invoke the API.

  4. Note the response for the API invocation. Because we used a valid phone number in this example, the response is valid.
    Image Modified

You have invoked an API using the API Console.


  1. Apply an offset of 3 to the default BAM port by editing the <BAM_HOME>/repository/conf/carbon.xml file. This makes the BAM server run on port 9446 instead of the default port 9443, and avoids port conflicts when multiple WSO2 products run on the same host.

    Code Block
  2. Download MySQL from and install it in your server.
  3. Go to the command-line and issue the following commands to connect to the MySQL server and create a database (e.g., TestStatsDB). This database is used to save the statistical data collected by the BAM. You do not need to create any tables in it.

    Code Block
    mysql -u <username> -p <password> -h <host_name or IP>;
  4. Save the MySQL connector JAR inside both the <APIM_HOME>/repository/components/lib and <BAM_HOME>/repository/components/lib folders.

  5. Give the datasource definition under the <datasource> element in the <BAM_HOME>/repository/conf/datasources/master-datasources.xml file. For example,

    Code Block
       <description>The datasource used for getting statistics to API Manager</description>
       <definition type="RDBMS">
               <validationQuery>SELECT 1</validationQuery>
  6. Start the BAM server by running either of the following commands in the command line:

    • On Windows:  <PRODUCT_HOME>\bin\wso2server.bat --run
    • On Linux/Solaris/Mac OS:  sh <PRODUCT_HOME>/bin/

  7. Start the API Manager and log in to its Admin Dashboard Web application (https://<Server Host>:9443/admin-dashboard) with admin/admin credentials.
  8. Click the Configure Analytics menu. 
    Image Removed Image Added

  9. Select the  check box to enable statistical data publishing and add the following:

    • Add a URL group as tcp://<BAM server IP>:7614 and click Add URL Group.
    • Fill the details under Statistics Summary Database according to the information you added to the master-datasources.xml file in step 4.

  10. Click Save. The BAM deploys the Analytics toolbox, which describes the information collected, how to analyze the data, and the location of the database where the analyzed data is stored.

  11. Invoke several APIs to generate some statistical data and wait a few seconds. 

  12. Connect to the API Publisher as a creator or publisher and click the statistical dashboards available under the All Statistics and Statistics menus. For example,
    The All Statistics menu is available for both API creators and publishers. It shows statistics of all APIs. The Statistics menu is available for API creators to see statistics of only the APIs created by them.