Dataset API

This article provides sample API calls used for obtaining data from a particular Dataset. You can either query all the data contained in that (All Data) View of the Dataset or specify a particular View and/or Time Instance.

PREREQUISITES:

1. Get data from an "All Data" View

  1. Token: enter a Token that you have previously obtained as noted in PREREQUISITES.
  2. Item:  select "dataset_data" from the drop-down.
  3. Method: only GET is currently supported.
  4. ID: must be left blank.
  5. Dataset ID:  enter the Dataset ID. Learn how to find your Dataset ID.
  6. Request URL (generated automatically): https://yourcompany.metricinsights.com/api/dataset_data?dataset=<id>.
  7. Run request.

1.1. Get data from a Specific View

To see a specific View, additionally enter a View ID. Learn how to find you Dataset View ID.

Request URL (generated automatically): https://yourcompany.metricinsights.com/api/dataset_data?dataset=<id>&view=<id> .

1.2. Get data from a Specific Dataset Instance

  1. Dataset ID: required
  2. View ID: optional
  3. Measurement_time: type in the date that you need to fetch your information for (only the following format is supported: yyyy-mm-dd). If Dataset is NOT "set to keep history", the "measurement_time" parameter is ignored during the API call. The Raw Response returns data exclusively for the last time the data was collected.

Request URL (generated automatically): https://yourcompany.metricinsights.com/api/dataset_data?dataset=<id>&view=<id>&measurement_time=yyyy-mm-dd .

2. Requested data appears in the Raw Response

In the example above, the data displayed in the Raw Response was pre-filtered for a specific View and Date.

Where can I find Dataset ID?

Dataset ID can be found in the the web browser URL of the Dataset Viewer or Dataset Editor:

https://stg530.metricinsights.com/dataset/index/index/ds/474

Where can I find Dataset View ID?

Dataset View ID can be found in the the web browser URL of the Dataset Viewer.

https://stg530.metricinsights.com/dataset/index/index/ds/474/filter/211

0 Comments

Add your comment

E-Mail me when someone replies to this comment