Skip to content

Profile Dataset

GET
/v1/datasets/{dataset_id}/profile
curl --request GET \
--url https://example.com/v1/datasets/example/profile \
--header 'Authorization: Bearer <token>'
dataset_id
required
Dataset Id
string

Successful Response

Media typeapplication/json
Response Getdatasetprofile
Array<object>
ColumnProfile
object
name
required
Name
string
type
required
Type
string
min
required
Any of:
string
max
required
Any of:
string
avg
required
Any of:
string
approx_unique
required
Any of:
integer
null_percentage
required
Any of:
number

Example generated

[
{
"name": "example",
"type": "example",
"min": "example",
"max": "example",
"avg": "example",
"approx_unique": 1,
"null_percentage": 1
}
]

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}