Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform various operations on Dataiku DSS resources directly from n8n workflows. Specifically for the Dashboard resource and the Get Dashboard operation, it retrieves detailed information about a specific dashboard within a given project.

Common scenarios where this node is beneficial include:

  • Automating retrieval of dashboard metadata or configuration for reporting or auditing.
  • Integrating Dataiku dashboards into broader automation workflows.
  • Fetching dashboard details dynamically based on workflow inputs.

Example use case:

  • A user wants to fetch the configuration of a dashboard by its ID in a project to analyze or export its settings as part of an automated data pipeline.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project containing the dashboard.
Dashboard ID The unique identifier of the dashboard to retrieve details for. Required for this operation.

Output

The output contains a JSON object representing the retrieved dashboard's details. This includes all metadata and configuration properties describing the dashboard as returned by the Dataiku DSS API.

If the operation involves downloading files (not applicable for Get Dashboard), binary data would be provided accordingly, but for "Get Dashboard" the output is purely 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.

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: If either the Project Key or Dashboard ID is not provided, the node throws an error specifying which parameter is required.
  • API Request Failures: Network issues, incorrect server URL, or insufficient permissions can cause API request failures. Check connectivity and credential permissions.
  • Invalid Dashboard ID: Providing a non-existent or incorrect dashboard ID will result in an API error; verify the dashboard ID exists in the specified project.

Links and References

Discussion