Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on Dataiku DSS resources programmatically. Specifically, for the Dashboard resource and the Create Dashboard operation, it allows creating a new dashboard within a specified project in Dataiku DSS.

Common scenarios where this node is beneficial include automating the creation and management of dashboards as part of data workflows, integrating dashboard creation into CI/CD pipelines, or dynamically generating dashboards based on external triggers or data changes.

For example, a user might automate the creation of dashboards for different projects after data ingestion completes, ensuring stakeholders always have up-to-date visualizations without manual intervention.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project where the dashboard will be created.
Request Body JSON object containing the details and configuration of the dashboard to create.
  • Project Key: Specifies the target project in Dataiku DSS.
  • Request Body: A JSON structure defining the dashboard's properties such as name, description, layout, widgets, etc., according to Dataiku DSS API specifications for dashboard creation.

Output

The node outputs the response from the Dataiku DSS API call:

  • The json output contains the parsed JSON response representing the newly created dashboard object, including its ID and other metadata returned by the API.
  • If the API returns binary data (not typical for dashboard creation), it would be provided in the binary output field, but this operation primarily returns JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid API credentials (an API key) configured in n8n to authenticate requests.
  • The node uses HTTP requests to interact with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node throws an error indicating missing credentials. Ensure that the API key credential is properly configured.
  • Required Parameter Errors: The node validates required parameters like Project Key and Dashboard ID (if applicable). Missing these will cause errors. Double-check input values.
  • API Errors: Any errors returned by the Dataiku DSS API (e.g., permission denied, invalid JSON in request body) will be surfaced as node errors. Review the error message and stack trace for details.
  • Invalid JSON in Request Body: The Request Body must be valid JSON. Invalid JSON syntax will cause parsing errors before sending the request.
  • Network Issues: Connectivity problems to the Dataiku DSS server will result in request failures. Verify network access and server URL correctness.

Links and References


This summary focuses on the "Dashboard" resource and the "Create Dashboard" operation as requested, describing the relevant inputs, outputs, and behavior based on static analysis of the provided source code and property definitions.

Discussion