Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This 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 Statistic resource and the Run Card operation, it enables running a statistical card computation within a worksheet of a dataset in a project. This is useful for generating detailed statistics or insights about data subsets directly from Dataiku DSS.

Common scenarios include:

  • Running predefined statistical cards on datasets to analyze data distributions or quality.
  • Automating data profiling tasks as part of an ETL or data science workflow.
  • Integrating Dataiku DSS dataset statistics into broader automation pipelines.

Example: You have a dataset in a Dataiku project and want to programmatically run a specific statistics card on a worksheet to get updated metrics or visualizations, which can then be used downstream in your workflow.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project containing the dataset.
Dataset Name The name of the dataset on which the statistics worksheet resides.
Worksheet ID The identifier of the statistics worksheet within the dataset where the card will run.
Request Body JSON object representing the request payload sent to the API when running the card.

Output

The output is a JSON array where each item corresponds to the response from the Dataiku DSS API call. For the "Run Card" operation under "Dataset Statistic", the output JSON contains the result of the card computation executed on the specified worksheet. This typically includes computed statistics, metrics, or other analytical results generated by the card.

If the operation involves downloading files (not applicable here), binary data would be returned accordingly, but for this operation, 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 API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • No additional external dependencies beyond the n8n environment and the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameters Missing: Errors like "Project Key is required", "Dataset Name is required", or "Worksheet ID is required" indicate that these mandatory inputs were not provided. Verify all required fields are filled.
  • API Endpoint Errors: If the API returns errors, check that the project key, dataset name, and worksheet ID exist and are accessible with the provided credentials.
  • Invalid JSON in Request Body: The Request Body property must contain valid JSON. Invalid JSON will cause parsing errors.
  • Network Issues: Ensure the Dataiku DSS server is reachable from the n8n instance.

Links and References


This summary focuses on the "Dataset Statistic" resource and the "Run Card" operation as requested, based on static analysis of the provided source code and input properties.

Discussion