Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to interact programmatically with various Dataiku DSS resources and operations. Specifically, for the Data Quality resource and the Get Dataset Current Status per Partition operation, it retrieves detailed status information about a dataset's quality metrics broken down by its partitions.

This functionality is beneficial in scenarios where data engineers or analysts need to monitor the health and quality of datasets at a granular partition level, such as daily or monthly partitions in large datasets. For example, you might use this node to automatically fetch the current data quality status per partition to trigger alerts if any partition shows degraded quality or to generate reports on dataset health over time.

Properties

Name Meaning
Project Key The unique identifier of the project containing the dataset.
Dataset Name The name of the dataset whose quality status per partition is to be retrieved.
Query Parameters Optional additional parameters to filter or modify the request (e.g., pagination, filters).

The Query Parameters collection can include various optional parameters such as:

  • includeAllPartitions (boolean): Whether to include all partitions.
  • limit (number): Maximum number of results to return.
  • page (number): Page number for paginated results.
  • Other filtering or control parameters supported by the API.

Output

The node outputs JSON data representing the detailed current status of the specified dataset, broken down by each partition. This includes quality metrics, rule evaluations, and other relevant status indicators per partition.

If the operation involves downloading files or binary content (not typical for this specific operation), the node would output binary data accordingly, but for this operation, the output is JSON structured data.

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 base URL of the DSS server and the user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameter Missing: Errors indicating missing "Project Key" or "Dataset Name" mean these inputs must be provided for the operation to succeed.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys will cause request failures. Verify connectivity and credential validity.
  • Unexpected Response Format: If the response cannot be parsed as JSON, check if the API endpoint has changed or if there are permission issues.

Links and References


This summary focuses on the Data Quality resource and the Get Dataset Current Status per Partition operation, describing how the node constructs the API request, required inputs, and expected outputs based on static code analysis.

Discussion