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 Dashboard resource and the List Dashboards operation, it retrieves a list of dashboards within a specified project.

Common scenarios where this node is beneficial include:

  • Automating retrieval of dashboard metadata for reporting or monitoring.
  • Integrating Dataiku DSS dashboards into other workflows or systems.
  • Managing dashboards programmatically as part of CI/CD pipelines or data governance processes.

Example use case:

  • A user wants to fetch all dashboards in a project to display their names and IDs in an external portal or to trigger further automation based on dashboard properties.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project from which to list dashboards.

The node supports many other properties for different resources and operations, but for the Dashboard - List Dashboards operation, only the Project Key is required.

Output

The output of the List Dashboards operation is a JSON array where each item represents a dashboard object retrieved from the Dataiku DSS API. Each dashboard object typically contains metadata describing the dashboard, such as its ID, name, description, creation date, and other relevant attributes defined by the Dataiku DSS API.

No binary data output is associated with this operation.

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 node throws "Missing Dataiku DSS API Credentials," ensure that the API key credential is properly set up in n8n.
  • Project Key Required: For the List Dashboards operation, if the Project Key is not provided, the node will throw an error indicating it is required.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credentials.
  • Unexpected Response Format: If the API response cannot be parsed as JSON, check if the Dataiku DSS API endpoint is returning the expected data or if there are permission issues.

Links and References


This summary focuses on the Dashboard resource's List Dashboards operation as requested, based on static analysis of the provided source code and property definitions.

Discussion