Help & Documentation
Open Support Ticket

Dataset API

The dataset API endpoint allows to get Dataset information, create new Datasets, update existing Datasets, and delete a Dataset.

Prerequisites:

Table of contents:

  1. Access Admin > System > API Toolkit
  2. Configure Dataset Info
    1. Get Dataset Info
    2. Create Dataset
    3. Update Dataset Info
      1. Validate Dataset
      2. Delete Dataset Data
      3. Get Dataset Access Map (User Map)
      4. Set Dataset Access Map (User Map)
      5. Enable Dataset
      6. Disable Dataset
      7. Update Dataset Data
    4. Delete Dataset

See Dataset Data API for information on configuring Dataset data via the dataset_data API.

1. Access Admin > System > API Toolkit

2. Configure Dataset Info

2.1. Get Dataset Info

  • The GET request to /api/dataset retrieves all Datasets.
  • The GET request to /api/dataset/id/<ID> retrieves the Dataset with the specified ID.
  1. Item: dataset.
  2. Methods: GET.
  3. Enter ID of the Dataset.
    • If no ID is provided, the API will return the data of all Datasets.
  4. Enter an API Token.
  5. [Run request]
  6. The returned object contains Dataset's info
Example Response 
{
  "dataset": {
    "id": 63,
    "source_dataset_id": 0,
    "source_dataset_filter_id": 0,
    "name": "Suppliers Analysis",
    "description": "Suppliers Analysis",
    "measurement_interval": 3,
    "data_storage": 1,
    "category": 65,
    "content_type_alias": "dataset",
    "data_collection_trigger": 1,
    "keep_history": "Yes",
    "measurement_time_source": "Measurement time command",
    "can_historical_instances_be_backfilled": "Y",
    "weekly_data_for": "Last day of Week",
    "custom_effective_date": 19,
    "data_source": "57_sql",
    "dataset_source": "0_0",
    "data_fetch_command": "SELECT * from dataset_61\nWHERE date = :measurement_time",
    "omit_partial_periods_ind": "No",
    "generate_empty_instance_ind": "skip generation",
    "generate_empty_instance_message": "No data available for this date.",
    "has_access_map_ind": "user has access to all rows",
    "instances_to_keep": 1095
  }
}

Fields Description

Field Name Value Type Description
can_historical_instances_be_backfilled string Whether or not multiple instances of the Snapshot Dataset can be computed at run time.
category string The ID of Dataset Category.
content_type_alias string The alias of the Content Type. For Datasets, this value is always "dataset".
data_collection_trigger string The ID of the Data Collection Trigger.
data_fetch_command string The command that is used to fetch the Dataset data.
data_source string The source of the Dataset data.
data_storage string The ID of the Data Storage.
description string The description of the Dataset.
has_access_map_ind string Whether the user has access to all Dataset rows or an access map is applied.
id string The ID of the Dataset.
instances_to_keep string The number of Dataset Shapshot instances to keep.
keep_history string Whether the Dataset is a Snapshot Dataset.
measurement_interval string The ID of the measurement interval.
name string The name of the Dataset
source_dataset_filter_id string The ID of the Dataset's filter from which this Dataset has been sourced.
source_dataset_id string The ID of the Dataset from which this Dataset has been sourced.

2.2. Create Dataset

  1. Item: dataset.
  2. Methods: POST.
  3. Enter ID of an existing Dataset that you want to use as a model for a new Dataset.
    • After you enter the Dataset ID, the Request field will display the settings for that Dataset.
  4. Select JSON request and modify the new Dataset's data.
  5. Enter an API Token.
  6. [Run request]
  7. The returned object contains the new Dataset's info.
    • Note that the new Dataset's ID is auto-created.

2.3. Update Dataset Info

  1. Item: dataset.
  2. Methods: PUT.
  3. Enter ID of the Dataset you want to update.
  4. Select JSON request and modify the Dataset's data.
  5. Enter an API Token.
  6. [Run request]

2.4. Validate Dataset

  1. Item: dataset.
  2. Methods: PUT.
  3. Enter ID of the Dataset you want to validate.
  4. Actions: Validate.
  5. Enter an API Token.
  6. [Run request]
  7. If the Dataset is validated successfully, a corresponding message is returned.

2.5. Delete Dataset Data

  1. Item: dataset.
  2. Methods: PUT.
  3. Enter ID of the Dataset which data you want to delete.
  4. Actions: Delete data.
  5. Enter an API Token.
  6. [Run request]

2.6. Get Dataset Access Map (User Map)

  1. Item: dataset.
  2. Methods: PUT.
  3. Enter ID of the Dataset for which you want to get an Access Map.
  4. Actions: Get Access Map.
  5. Enter an API Token.
  6. [Run request]
  7. If the Dataset's Access Map data is fetched successfully, its data is returned.

2.7. Set Dataset Access Map (User Map)

  1. Item: dataset.
  2. Methods: PUT.
  3. Enter ID of the Dataset for which you want to set an Access Map.
  4. Actions: Set Access Map.
  5. Select JSON request and provide JSON mapping Dataset parameters with User Map parameters.
  6. Enter an API Token.
  7. [Run request]
  8. If the Dataset's Access Map data is set successfully, a corresponding message is returned.

2.8. Enable Dataset

  1. Item: dataset.
  2. Methods: PUT.
  3. Enter ID of the Dataset you want to enable.
  4. Actions: Enable.
  5. Enter an API Token.
  6. [Run request]
  7. If the Dataset is enabled successfully, a corresponding message is returned.

2.9. Disable Dataset

  1. Item: dataset.
  2. Methods: PUT.
  3. Enter ID of the Dataset you want to disable.
  4. Actions: Disable.
  5. Enter an API Token.
  6. [Run request]
  7. If the Dataset is disabled successfully, a corresponding message is returned.

2.10. Update Dataset Data

  1. Item: dataset.
  2. Methods: PUT.
  3. Enter ID of the Dataset which data you want to update.
    • This action is an equivalent of [Update Dataset] from the Dataset Editor.
  4. Actions: Update Dataset.
  5. Enter an API Token.
  6. [Run request]
  7. If the Dataset has been updated successfully, a corresponding message is returned.

2.11. Delete Dataset

  1. Item: dataset.
  2. Methods: DELETE.
  3. Enter ID of the Dataset you want to delete.
  4. Enter an API Token.
  5. [Run request]
  6. If the Dataset is deleted successfully, a corresponding message is returned.