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 Data Quality Project Timeline operation, it retrieves a detailed timeline of data quality statuses for each dataset within a specified project. This timeline is grouped by day and filtered between optional timestamps.

Use cases include monitoring the evolution of data quality metrics over time in a Dataiku project, auditing dataset health trends, or integrating data quality insights into automated workflows.

Example scenarios:

  • Automatically fetch daily data quality status timelines to trigger alerts if quality degrades.
  • Aggregate historical data quality information for reporting dashboards.
  • Integrate data quality timelines into broader data governance pipelines.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project for which to retrieve the data quality timeline.
Query Parameters Optional additional parameters to filter or paginate the timeline data. Includes options such as:
- active (boolean)
- activity (string)
- allUsers (boolean)
- limit (number): Max number of results to return
- page (number)
- filter (string)
- minTimestamp (number)
- onlyMonitored (boolean)
- resultsPerPage (number)
- withScenarios (boolean)
...and many others as per the full list provided.

The Query Parameters collection allows fine-tuning the request, such as filtering by activity, limiting results, or including/excluding certain datasets or users.

Output

The node outputs JSON data representing the detailed timeline of data quality statuses for datasets in the specified project. The structure corresponds to the response from the Dataiku DSS API endpoint /projects/{projectKey}/data-quality/timeline.

  • The output JSON typically includes entries grouped by date, each containing data quality status details per dataset.
  • If the operation involves downloading files or binary content (not applicable here), the node would output binary data accordingly.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid API credentials consisting of the DSS server URL and a user API key.
  • The node expects these credentials to be configured in n8n under a generic "API key credential" for authentication.
  • The node makes HTTP requests to the Dataiku DSS REST API endpoints.

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.
  • Required Parameter Errors: The node validates required parameters like Project Key. Missing these will cause errors such as "Project Key is required."
  • HTTP 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 changes or returns unexpected data, parsing errors may occur. Check the Dataiku DSS API version compatibility.
  • Large Result Sets: When requesting large timelines, consider using pagination parameters (limit, page) to avoid timeouts or memory issues.

Links and References

This summary focuses on the Data Quality resource's Get Data Quality Project Timeline operation, describing its purpose, inputs, outputs, dependencies, and common troubleshooting tips based on static analysis of the provided source code and property definitions.

Discussion