Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to interact programmatically with various Dataiku DSS resources and operations. Specifically for the Dataset Statistic resource with the Get Worksheet operation, it retrieves a statistics worksheet object from a specified dataset within a project.

Common scenarios where this node is beneficial include:

  • Automating retrieval of dataset statistical summaries for reporting or monitoring.
  • Integrating Dataiku DSS dataset statistics into broader data workflows.
  • Fetching worksheet details to analyze or visualize dataset statistics externally.

Example use case:

  • A user wants to fetch the statistics worksheet of a dataset to monitor data quality metrics regularly and trigger alerts if anomalies are detected.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the dataset.
Dataset Name The name of the dataset within the project whose statistics worksheet is to be retrieved.
Worksheet ID The identifier of the specific statistics worksheet to get from the dataset.

Output

The node outputs the JSON representation of the requested statistics worksheet object. This includes all metadata and details describing the worksheet as provided by the Dataiku DSS API.

If the operation involves downloading files (not applicable here), the node would output binary data representing the downloaded file.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node expects the base URL of the DSS server and the API key credential to be configured in n8n.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: The node validates required parameters such as Project Key, Dataset Name, and Worksheet ID. Omitting any of these will cause an error specifying which parameter is missing.
  • API Request Failures: Network issues, incorrect URLs, or permission problems on the DSS side can cause request failures. Check the DSS server URL, API key permissions, and network connectivity.
  • Parsing Errors: If the response from the API is not valid JSON when expected, the node may fail to parse it. This could indicate an unexpected API response or server error.

Links and References


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

Discussion