Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to interact programmatically with various Dataiku DSS resources and operations. Specifically, for the Data Quality resource and the Get Dataset Current Status operation, the node retrieves the current data quality status of a specified dataset within a project.

This functionality is beneficial in scenarios where automated monitoring or reporting of dataset health and quality metrics is required. For example, a data engineer might use this node to periodically check the quality status of critical datasets and trigger alerts or downstream workflows if issues are detected.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project containing the dataset.
Dataset Name The name of the dataset whose current data quality status is to be retrieved.

These properties must be provided to specify which dataset's data quality status should be fetched.

Output

The node outputs the response from the Dataiku DSS API call to get the current status of the dataset's data quality. The output is structured as JSON under the json field.

  • The JSON contains detailed information about the current data quality status of the specified dataset.
  • This may include metrics, rule evaluations, and overall health indicators as provided by the Dataiku DSS API.
  • No binary data output is associated with this operation.

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 expects the Dataiku DSS server URL and user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Errors: The node validates that both "Project Key" and "Dataset Name" are provided; otherwise, it throws errors specifying the missing parameter.
  • API Request Failures: Network issues, incorrect project or dataset names, or insufficient permissions can cause API request failures. The node surfaces these errors with messages prefixed by "Error calling Dataiku DSS API".
  • Parsing Errors: If the API returns non-JSON responses unexpectedly, the node attempts to handle them gracefully but may output raw text or logs instead.

To resolve common issues:

  • Ensure the API key credential is correctly configured.
  • Verify that the project key and dataset name are accurate and accessible.
  • Check network connectivity to the Dataiku DSS server.
  • Confirm that the API user has sufficient permissions to access data quality information.

Links and References


This summary focuses on the "Data Quality" resource and the "Get Dataset Current Status" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion