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 Insight resource with the Create Insight operation, it enables creating new insights within a specified project in Dataiku DSS.

Common scenarios where this node is beneficial include automating the creation and management of insights as part of data workflows, integrating Dataiku DSS insights into broader automation pipelines, or programmatically managing insights based on dynamic inputs.

For example, you might use this node to:

  • Automatically create an insight after running a data analysis job.
  • Integrate insight creation into a CI/CD pipeline for Dataiku projects.
  • Create multiple insights programmatically based on external triggers or datasets.

Properties

Name Meaning
Project Key The key identifier of the Dataiku DSS project where the insight will be created.
Request Body JSON object representing the details of the insight to create (e.g., insight configuration).

Output

The output of the node is a JSON array where each item corresponds to the response from the Dataiku DSS API for the insight creation request.

  • The json field contains the parsed JSON response from the API, which typically includes details about the newly created insight such as its ID, name, and other metadata.
  • If the API returns binary data (not typical for insight creation), it would be provided in the binary field, but for this operation, output is expected to be JSON.

Example output snippet (conceptual):

[
  {
    "json": {
      "id": "insight_12345",
      "name": "My New Insight",
      "projectKey": "MY_PROJECT",
      "createdAt": "2024-06-01T12:00:00Z",
      "details": { ... }
    }
  }
]

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.
  • No additional external dependencies beyond the standard n8n environment and the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Project Key Required: The operation requires a valid project key; if omitted or incorrect, the node will throw an error.
  • Request Body Format: The request body must be valid JSON representing the insight configuration. Invalid JSON or missing required fields may cause API errors.
  • API Errors: Errors returned by the Dataiku DSS API will be surfaced with messages prefixed by "Error calling Dataiku DSS API". Check the message and stack trace for details.
  • Network Issues: Ensure that the n8n instance can reach the Dataiku DSS server URL and that no firewall or network restrictions block the requests.

Links and References

This summary focuses on the Insight resource's Create Insight operation as requested, describing the input properties, output structure, and relevant usage context based on static code analysis.

Discussion