Classify Collection

post

Detect personal or sensitive information within a structured data set.

Authorizations

sec0

x-api-keystringRequired

Body

application/json

contentstring[]Optional

set of rows to classify for a given column

Default: ["[\"John\"","\"Chris\"","\"Tanner\"","\"Dave\"]]"]

metadatastring[]Optional

context to take into consideration, such as column name, table name, database name, etc.

Default: ["[\"first_name\"","\"users\"","\"users_production\"]]"]

content_typestringOptional

column type (e.g int64, string)

Default: string

Responses

200

200

application/json

400

400

application/json

post

/v1/classifyCollection

HTTPcURLJavaScriptPython

POST /v1/classifyCollection HTTP/1.1
Host: api.scanner.demo-001.teleskope.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "content": [
    "text"
  ],
  "metadata": [
    "text"
  ],
  "content_type": "string"
}

{
	"classifications": [
		{
			"data_element": "FIRST_NAME",
      "category": "PERSONAL",
			"star_char": 15,
			"char_size": 4,
      "row_index": 2000,
		},
		{
			"data_element": "LAST_NAME",
      "category": "PERSONAL",
			"star_char": 20,
			"char_size": 3,
      "row_index": 2002,
		},
		{
			"data_element": "EMAIL",
      "category": "PERSONAL",
			"star_char": 45,
			"char_size": 18,
      "row_index": 2005,
		}
	]
}