Help & DocumentationAPI Access API Calls in JavaScriptLooking in Metric Insights to see what items to pull via API

Looking in Metric Insights to see what items to pull via API

This article is a follow on to the one that provides an example of using the Metric Insights API via JavaScript to display items in your website.

This section gives a quick overview of where to look in Metric Insights to determine which elements (Metrics or Reports) to use in your API calls. In these examples the elements contain Alerts, Annotations, Notes and other items that you might want to pull via API to your website.

NOTE: The format of the API Test Tool is slightly different in Version 3.

1. API via JavaScript - Determine which Element ID to use

API via JavaScript - Determine which Element ID to use

In the example here we have a web page that calls the API via JavaScript. In the page, we need to determine which element ID to use for pulling content from Metric Insights.

1. In this example we just hardcode the Metric Insights element ID that contains the items we are interested in such as Alerts, Annotations and Notes. The next sections give you tips on how to determine which Element ID to use.

1.1. Element ID on a Metric Viewer

The Metric is what is used in Metric Insights to trigger the Alerts; so use this element in your API calls to get the Alerts, Annotations, Notes and other items.

To determine the Element ID for a Metric Insights element:

1. The Element ID for the Metric and any other element can be found in the web browser URL. For example, this Metric element ID is "686" which is seen in the URL:

https://demo.metricinsights.com/chart/index/index/element/686

Additionally, if you want to see the Alert Rules:

2. Click on the Alert icon to display the Alert Rules for this Metric

2. Metric with Alert Rules

2.1. Viewing Alerts, Annotations, Notes

In the Metric Viewer, scroll down to see the Alerts, Annotations, and Notes added to your Metric. These are the same items you can pull into your website using the API.

2.2. Viewing Alerts

In the Metric Editor, switch to the Alerting tab to see the Alert History for your Metric. These are items you can pull into your website using the API.

3. Report with Alert Rules

If your Alerts are sent via an Image of your dashboard from your Business Intelligence application, then you can view the corresponding Alert Rules directly from the Metric Insights dashboard.

1. Click the Alert icon to display the Alert Rules for this Report

3.1. Report with Alert Rules

0 Comments

Add your comment

E-Mail me when someone replies to this comment