Data Scan Async

Note: Data Scan APIs are not available for trial users. A subscription is required to access these features. Please get in touch with help@protecto.ai for assistance. #

This API enables users to submit data scan requests asynchronously for specific data sources and objects. Users can optionally include sample values for different columns. When a request is submitted, the API returns a tracking ID that can be used to monitor the scan’s progress

Endpoint: /data-scan/data-scan-async

HTTP Method: PUT

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.

Request Payload:

Eg: Json

[
  {
    "data_source_name": "salesforce",
    "object_name": ["CustomerDB", "Marketingschema", "Customerstable"],
    "data_samples": [
      {
        "column_name": "CustomerID",
        "samples": ["CID32", "CID34", "CID56", "CID58"]
      },
            {
        "column_name": "email",
        "samples": ["John@gmail.com", "Williams.hary@yahoo.com"]
      }
    ]
  }
]

Input Parameters

• data_source_name: Data source identifier name. The user can specify any name (e.g., snowflake, MySQL, etc.).
• object_name: Fully qualified table name/object name as a list, Eg [“database”, “schema”, “table”].
• data_samples: A list containing objects with the keys:
  • column_name: The name of the column for which samples are provided.
  • samples: An array of sample values for the specified column.

Sample Output:

{
  "data": {
    "tracking_id": "47882682-9f38-4f45-afec-daadaa1b230b"
  },
  "success": "true",
  "error": {
    "message": ""
  }
}

Response Parameter:

tracking_id: A unique identifier for the scan request