Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node interacts with the Dataiku DSS API to perform various operations on datasets and other resources within a Dataiku DSS instance. Specifically, for the Dataset resource and the Get Single Metric History operation, it retrieves the historical values of a single metric for a specified dataset in a project.

This node is beneficial when you want to programmatically access detailed metric history data from your datasets in Dataiku DSS, enabling automation of monitoring, reporting, or integration with other systems.

Example use cases:

  • Fetching the historical trend of a quality metric on a dataset to analyze data quality over time.
  • Integrating metric history into dashboards or alerting systems.
  • Automating compliance checks by retrieving metric histories regularly.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the dataset.
Dataset Name The name of the dataset for which the metric history is requested.
Query Parameters Optional additional parameters to filter or paginate the request (e.g., limit, page).

The Query Parameters collection supports many optional fields such as:

  • limit: Maximum number of results to return.
  • page: Page number for paginated results.
  • Other filters depending on the API endpoint capabilities.

Output

The output JSON contains the response from the Dataiku DSS API for the single metric history request. This typically includes an array or object representing the historical metric values over time for the specified dataset.

If the operation involves downloading files (not applicable here), binary data would be returned accordingly, but for this operation, the output is JSON-formatted metric history data.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: The node validates required parameters like Project Key and Dataset Name; if these are missing, it throws descriptive errors.
  • API Request Failures: Network issues, incorrect project or dataset names, or insufficient permissions can cause API call failures. Check the error message for details.
  • Parsing Errors: If the API returns unexpected data formats, JSON parsing might fail. Ensure the Dataiku DSS API version is compatible.

Links and References


This summary focuses on the Dataset resource's Get Single Metric History operation based on the provided source code and property definitions.

Discussion