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. Specifically for the Dataset resource and the Get Last Metric Values operation, it retrieves the latest metric values computed on a specified dataset or dataset partition within a project.

This functionality is useful in scenarios where you want to monitor or analyze the most recent metrics of your datasets, such as data quality scores, statistical summaries, or custom metrics defined in Dataiku DSS. For example, you might use this node to fetch the last metric values before triggering alerts or reports based on data health.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the dataset.
Dataset Name The name of the dataset from which to retrieve the last metric values.
Query Parameters Optional additional parameters to filter or modify the request (e.g., partitions, limits).

The Query Parameters collection can include various optional filters or settings, such as:

  • partition: Specify a particular partition of the dataset.
  • limit: Maximum number of metric results to return.
  • Other parameters supported by the Dataiku DSS API for this endpoint.

Output

The node outputs the JSON response from the Dataiku DSS API call to get the last metric values of the specified dataset. The output structure corresponds directly to the API's response, typically including:

  • A list or dictionary of metric names and their latest values.
  • Metadata about the metrics, such as timestamps or partitions if applicable.

If the API returns binary data (not typical for this operation), it would be provided as binary output, but for "Get Last Metric Values," the output is JSON.

Example output snippet (conceptual):

[
  {
    "metricName": "row_count",
    "lastValue": 12345,
    "timestamp": "2024-06-01T12:00:00Z"
  },
  {
    "metricName": "null_percentage",
    "lastValue": 0.02,
    "timestamp": "2024-06-01T12:00:00Z"
  }
]

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) configured in n8n for authentication.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST 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.
  • Required Parameter Errors: The node validates required parameters like Project Key and Dataset Name. Missing these will cause errors; provide all mandatory fields.
  • API Request Failures: Network issues, incorrect URLs, or insufficient permissions in Dataiku DSS may cause API call failures. Check connectivity and user permissions.
  • Unexpected Response Format: If the API response cannot be parsed as JSON, verify that the Dataiku DSS server is returning valid responses and that the correct operation/resource is selected.

Links and References


This summary focuses on the Dataset resource and the Get Last Metric Values operation, describing how the node constructs the API request, handles inputs, and processes outputs accordingly.

Discussion