Access DQ Rule information via REST API

Overview

All information about Data Quality (DQ) rules is accessible through the DvSum web user interface and is also available via API. Using the API provides users with greater flexibility and control over their DQ results. For example, you can integrate the data into a corporate BI tool or dashboard, or archive the results for future review.

The data retrieved via API corresponds to what is displayed on the DQ Dictionary page and is filtered based on the specific views of your rules that you define on this page.

Detailed Steps

API Key

To make a web services call, an API key is required in the request header.

You can retrieve the API key by navigating to:
Administration → Account Settings → Application Security
From there, you can copy the API key for use.

Making an API Call to Retrieve DQ Rules

To fetch a list of Data Quality (DQ) Rules, follow the steps below:

Key Information

• Base URL:
  https://apis.dvsum.ai/node-listing/listing/rules?view-name=

• Parameter:

  • Name: view-name
  • Value: Specify the name of the DQ Rules view you have defined in DvSum.
    Example: Use "DQ Rules" for the pre-defined view available to all users.

• Headers:

  • Key: x-api-key
  • Value: Use the API key obtained in the previous step.
  • Authorization: Set to "default" under headers.

Example API Call

https://apis.dvsum.ai/node-listing/listing/rules?view-name=DQ Rules

Ensure to replace view-name with your desired DQ Rules view name as required.

Example

Viewing DQ Rules in DvSum

To access and define views in DvSum, follow these steps:

1. Navigate to the DQ Dictionary:

   • Go to DQ Dictionary in the DvSum platform.

2. Select a View:

   • Choose any available view to retrieve the rules and fields relevant to your needs.

3. Default View:

   • The default view is "DQ Rules", which is accessible to all users.
   • You can also define a custom view to specify the rules and fields you want to retrieve.

These views can be used as input parameters for API calls to fetch specific Data Quality rules and related fields.

View in Postman

Configure the URL, parameters, and headers. The selected view here is "Analyze Rules."

The header and the successful JSON response to the GET request are displayed here.