Set up API Access

To configure your Metric Insights instance for API Access, you should create a secret key by the means of which your API client can access the data.

Once you set up API Access you can use most of the API calls. A few calls are unavailable until you set up specific access for them.

Steps 3 and 4 describe what they are and how to enable access for them. In general, this includes access to the user API as well as access to all API calls from external web sites (typically via JavaScript).

Table of contents:

  1. Access Admin > System > External Applications
  2. Configure the External Application
  3. Enable User API Calls
  4. Enable API Calls from External Web Sites

1. Access Admin > System > External Applications

  1. Select [+ New External Application] below the External Applications grid
  2. Define the Name of an External Application
  3. [Save]

2. Configure the External Application

  1. Enable your API
  2. [Show credentials]
  3. The Application ID and Application key are now available to you

3. Enable User API Calls

  1. Enable Application Can Manage Users setting

If 'User Management Access' is Inactive

If Application Can Manage Users setting is not enabled (as shown in Step 3), then api/user API calls will fail with error "External Application has no User Management Access".

4. Enable API Calls from External Web Sites

  1. Enable Allow Cross Domain Access
  2. Click [+ New Cross Domain Origin] to add specific web sites that will access the API
  3. [Save]
  4. [Save]