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. Specifically, for the Dataset Statistic resource and the List Worksheets operation, it retrieves a list of statistics worksheets associated with a specified dataset within a project.

This functionality is useful when you want to automate the retrieval of statistical worksheets metadata from datasets in Dataiku DSS, for example:

  • To monitor or audit dataset statistics worksheets.
  • To feed worksheet metadata into downstream workflows or reporting tools.
  • To dynamically fetch available worksheets before running further analyses or computations on them.

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 worksheets are to be listed.

These properties must be provided to specify the context (project and dataset) for listing the statistics worksheets.

Output

The output is a JSON array where each item represents a statistics worksheet object associated with the specified dataset. Each worksheet object contains metadata describing the worksheet.

If the operation succeeds, the node returns this list as the json output field.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key token) 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 Parameters Missing: The node validates that both "Project Key" and "Dataset Name" are provided; if either is missing, it throws an error specifying which parameter is required.
  • API Request Failures: Network issues, incorrect project or dataset names, or insufficient permissions can cause API request failures. The node surfaces these errors with descriptive messages.
  • Parsing Errors: If the API response is not valid JSON, the node attempts to handle it gracefully but may return raw text or an error.

To resolve common issues:

  • Ensure the API key credential is correctly configured and has sufficient permissions.
  • Verify that the project key and dataset name are correct and accessible.
  • Check network connectivity to the Dataiku DSS server.
  • Review error messages for specific missing parameters or permission issues.

Links and References


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

Discussion