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 Data Quality Project Current Status operation, it retrieves the latest data quality status of each dataset within a specified project.

This functionality is beneficial in scenarios where you want to monitor the health and quality of datasets across a project automatically, such as triggering alerts or downstream processes based on data quality metrics. For example, a data engineer might use this node to fetch current data quality statuses daily and log or visualize them for compliance and monitoring purposes.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project whose data quality status you want to retrieve.
Query Parameters Optional additional parameters to filter or modify the request. Available options include: Active (boolean), Activity (string), All Users (boolean), Archive Path (string), Catalog Name (string), Column Name (string), Limit (number), Page (number), Partition (string), Tags (string), Wait (boolean), With Scenarios (boolean), and many others. These parameters allow fine-tuning of the API call.

Note: The full list of query parameters is extensive; they provide granular control over filtering, pagination, and other aspects of the API request.

Output

The node outputs JSON data representing the current data quality status of each dataset in the specified project. The structure typically includes details about datasets and their associated data quality metrics and statuses.

If the operation involves downloading files (not applicable for this specific operation), the node can output binary data representing those files.

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 node throws an error about missing credentials, ensure that the API key credential for Dataiku DSS is properly set up in n8n.
  • Project Key Required: The operation requires a valid project key. Omitting this will cause an error.
  • API Request Errors: Errors returned from the Dataiku DSS API (e.g., 404 Not Found, 401 Unauthorized) indicate issues like invalid project keys, insufficient permissions, or expired API keys. Verify the inputs and credentials.
  • Network Issues: Ensure that the n8n instance can reach the Dataiku DSS server URL.
  • Invalid Query Parameters: Using unsupported or incorrectly formatted query parameters may cause API errors. Refer to Dataiku DSS API documentation for valid parameters.

Links and References


This summary focuses on the "Data Quality" resource and the "Get Data Quality Project Current Status" operation, describing how the node constructs the API request, required inputs, and expected outputs based on static code analysis.

Discussion