The API lets users obtain detailed information about objects within a specified data source. The level of detail returned by the API depends on the input provided.
For authentication, include the following token in the request headers:
Headers: {“Authorization”: “Bearer <AUTH_TOKEN>”}
Note: To obtain the <auth token>, please refer to the Step-by-Step Guide to Obtain Your Auth Token.
HTTP Method: PUT
Endpoint: /data-scan/objects/details
Input Formats:
The input JSON can be provided in different formats based on the level of detail required:
Format 1: Data Source Name Only
-
- Description: Retrieve details for all objects within the specified data source.
Sample Input
{
"data": {
"data_source_name": "snowflake"
},
"next_page_token": null
}
Format 2: Data Source Name and object_name at any level
-
- Description: Retrieve details for all objects within the specified object path.
Sample Input 1:
{
"data": {
"data_source_name": "snowflake",
"object_name": ["CustomerDB", "MarketingSchema"]
},
"next_page_token": null
}
Sample Input 2:
{
"data": {
"data_source_name": "snowflake",
"object_name": ["CustomerDB", "MarketingSchema", "Customerstable"]
},
"next_page_token": null
}
Pagination:
- If there are more details available than can be returned in a single response due to API size limitations, the response will include a next_page_token. Use this token to retrieve the next set of results by including it in the subsequent request.
Sample Input for Next Page:
{
"data": {
"data_source_name": "snowflake"
},
"next_page_token": "478826829f384f45afecdaadaa1b230b"
}
Sample Output:
{
"details": [
{
"data_source_name": "snowflake",
"object_name": ["CustomerDB", "MarketingSchema", "Customerstable"],
"columns": [
{
"column_name": "CustomerID",
"values_scanned": 250,
"user_defined_pi_details": null,
"ml_identified_pi_details": [
{
"pi_type": "PERSON",
"identified_count": 128,
"identified_percentage": 20
},
{
"pi_type": "ADDRESS",
"identified_count": 80,
"identified_percentage": 20
}
]
},
{
"column_name": "Email",
"values_scanned": 205,
"user_defined_pi_details": "EMAIL_ADDRESS",
"ml_identified_pi_details": [
{
"pi_type": "-",
"identified_count": 0,
"identified_percentage": 0
}
]
}
]
}
],
"next_page_token": "478826829f384f45afecdaadaa1b230b",
"success": "true",
"error": {
"message": ""
}
}
