Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

The node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Dataset resource and the Run Checks operation, this node triggers the execution of data quality checks defined on a specified dataset within a project in Dataiku DSS.

This is useful in scenarios where you want to automate data validation workflows, ensure data integrity, or monitor datasets for quality issues as part of an ETL pipeline or data engineering process. For example, after loading new data into a dataset, you can run these checks to verify that the data meets expected quality standards before further processing.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the dataset.
Dataset Name The name of the dataset on which to run the checks.
Query Parameters Optional additional query parameters to customize the API request (e.g., filters, limits).
Request Body JSON object representing the body of the request if needed by the specific API call.

Note: The above properties are relevant to the "Run Checks" operation on the Dataset resource. Other properties exist for other resources and operations but are not applicable here.

Output

The output of the "Run Checks" operation is the JSON response from the Dataiku DSS API representing the result of running the checks on the specified dataset. This typically includes details about the executed checks, their status, any errors or warnings found, and possibly metrics or summaries related to data quality.

If the API returns binary data (not typical for this operation), it would be provided as binary output, but for "Run Checks," the output is JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS server.
  • The node expects the base URL of the Dataiku DSS server and the user API key to be configured in the credentials.
  • No additional external dependencies beyond the Dataiku DSS API and n8n's HTTP request capabilities.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing Dataiku DSS API credentials. Ensure the API key and server URL are correctly configured.
  • Required Parameter Errors: The node validates required parameters such as Project Key and Dataset Name. Missing these will cause errors. Make sure these fields are filled.
  • API Request Failures: Network issues, incorrect URLs, or permission problems on the Dataiku DSS side may cause API call failures. Check connectivity and permissions.
  • Unexpected Response Format: If the API returns unexpected data or errors, the node attempts to parse JSON; failure to parse will return raw text. Review the API response for clues.
  • Rate Limits or Quotas: If the Dataiku DSS API enforces rate limits, excessive calls might be throttled or rejected.

Links and References


This summary focuses on the Dataset resource's Run Checks operation as requested, based on static analysis of the provided source code and property definitions.

Discussion