GET /v1/tables/{id}/profilerConfig

from metadata.sdk import configure
from metadata.sdk.entities import Tables

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

table_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

# Get profiler config
config = Tables.get_profiler_config(table_id)
print(f"Sample: {config.get('profileSample')}%")

# Set profiler config - profile 50% of rows
Tables.set_profiler_config(table_id, {
    "profileSample": 50,
    "profileSampleType": "PERCENTAGE",
    "sampleDataCount": 200,
    "excludeColumns": ["created_at"]
})

# Set profiler config with specific column metrics
Tables.set_profiler_config(table_id, {
    "profileSample": 100,
    "profileSampleType": "PERCENTAGE",
    "includeColumns": [
        {"columnName": "email", "metrics": ["distinctCount", "nullCount"]},
        {"columnName": "name", "metrics": ["distinctCount", "maxLength", "minLength"]}
    ]
})

# Delete profiler config
Tables.delete_profiler_config(table_id)

import static org.openmetadata.sdk.fluent.Tables.*;

String tableId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";

// Get profiler config
var config = Tables.getProfilerConfig(tableId);

// Set profiler config
Tables.setProfilerConfig(tableId, Map.of(
    "profileSample", 50,
    "profileSampleType", "PERCENTAGE",
    "sampleDataCount", 200,
    "excludeColumns", List.of("created_at")
));

// Delete profiler config
Tables.deleteProfilerConfig(tableId);

# Get profiler config
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}"

# Set profiler config
curl -X PUT "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "profileSample": 50,
    "profileSampleType": "PERCENTAGE",
    "sampleDataCount": 200,
    "excludeColumns": ["performance_score"]
  }'

# Delete profiler config
curl -X DELETE "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}"

# Get table profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/tableProfile" \
  -H "Authorization: Bearer {access_token}"

# Get column profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/columnProfile" \
  -H "Authorization: Bearer {access_token}"

# Get system profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/systemProfile" \
  -H "Authorization: Bearer {access_token}"

{
  "profileSample": 50,
  "profileSampleType": "PERCENTAGE",
  "sampleDataCount": 200,
  "excludeColumns": ["created_at"]
}

GET

tables

{id}

profilerConfig

GET /v1/tables/{id}/profilerConfig

from metadata.sdk import configure
from metadata.sdk.entities import Tables

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

table_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

# Get profiler config
config = Tables.get_profiler_config(table_id)
print(f"Sample: {config.get('profileSample')}%")

# Set profiler config - profile 50% of rows
Tables.set_profiler_config(table_id, {
    "profileSample": 50,
    "profileSampleType": "PERCENTAGE",
    "sampleDataCount": 200,
    "excludeColumns": ["created_at"]
})

# Set profiler config with specific column metrics
Tables.set_profiler_config(table_id, {
    "profileSample": 100,
    "profileSampleType": "PERCENTAGE",
    "includeColumns": [
        {"columnName": "email", "metrics": ["distinctCount", "nullCount"]},
        {"columnName": "name", "metrics": ["distinctCount", "maxLength", "minLength"]}
    ]
})

# Delete profiler config
Tables.delete_profiler_config(table_id)

import static org.openmetadata.sdk.fluent.Tables.*;

String tableId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";

// Get profiler config
var config = Tables.getProfilerConfig(tableId);

// Set profiler config
Tables.setProfilerConfig(tableId, Map.of(
    "profileSample", 50,
    "profileSampleType", "PERCENTAGE",
    "sampleDataCount", 200,
    "excludeColumns", List.of("created_at")
));

// Delete profiler config
Tables.deleteProfilerConfig(tableId);

# Get profiler config
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}"

# Set profiler config
curl -X PUT "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "profileSample": 50,
    "profileSampleType": "PERCENTAGE",
    "sampleDataCount": 200,
    "excludeColumns": ["performance_score"]
  }'

# Delete profiler config
curl -X DELETE "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}"

# Get table profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/tableProfile" \
  -H "Authorization: Bearer {access_token}"

# Get column profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/columnProfile" \
  -H "Authorization: Bearer {access_token}"

# Get system profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/systemProfile" \
  -H "Authorization: Bearer {access_token}"

{
  "profileSample": 50,
  "profileSampleType": "PERCENTAGE",
  "sampleDataCount": 200,
  "excludeColumns": ["created_at"]
}

Table Profiler

Manage the profiler configuration for a table and retrieve profiling results including table-level, column-level, and system-level profiles.

Get Profiler Config

GET /v1/tables/{id}/profilerConfig

string

required

UUID of the table.

Set Profiler Config

PUT /v1/tables/{id}/profilerConfig

string

required

UUID of the table.

number

Sample size for profiling (percentage or row count depending on profileSampleType).

string

Type of sample: PERCENTAGE or ROWS.

integer

Number of sample data rows to collect during profiling.

string

Custom SQL query to use for profiling instead of the full table.

array

List of column names to exclude from profiling.

array

List of column-level profiler configurations.

Show properties

string

Name of the column.

array

List of metrics to compute for this column.

Delete Profiler Config

DELETE /v1/tables/{id}/profilerConfig

string

required

UUID of the table.

Get Table Profile

GET /v1/tables/{id}/tableProfile Returns table-level profiling results (row count, size, creation date).

string

required

UUID of the table.

Get Column Profile

GET /v1/tables/{id}/columnProfile Returns column-level profiling results (min, max, mean, null count, distinct count).

string

required

UUID of the table.

Get System Profile

GET /v1/tables/{id}/systemProfile Returns system-level profiling results (DML operations, rows affected).

string

required

UUID of the table.

GET /v1/tables/{id}/profilerConfig

from metadata.sdk import configure
from metadata.sdk.entities import Tables

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

table_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

# Get profiler config
config = Tables.get_profiler_config(table_id)
print(f"Sample: {config.get('profileSample')}%")

# Set profiler config - profile 50% of rows
Tables.set_profiler_config(table_id, {
    "profileSample": 50,
    "profileSampleType": "PERCENTAGE",
    "sampleDataCount": 200,
    "excludeColumns": ["created_at"]
})

# Set profiler config with specific column metrics
Tables.set_profiler_config(table_id, {
    "profileSample": 100,
    "profileSampleType": "PERCENTAGE",
    "includeColumns": [
        {"columnName": "email", "metrics": ["distinctCount", "nullCount"]},
        {"columnName": "name", "metrics": ["distinctCount", "maxLength", "minLength"]}
    ]
})

# Delete profiler config
Tables.delete_profiler_config(table_id)

import static org.openmetadata.sdk.fluent.Tables.*;

String tableId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";

// Get profiler config
var config = Tables.getProfilerConfig(tableId);

// Set profiler config
Tables.setProfilerConfig(tableId, Map.of(
    "profileSample", 50,
    "profileSampleType", "PERCENTAGE",
    "sampleDataCount", 200,
    "excludeColumns", List.of("created_at")
));

// Delete profiler config
Tables.deleteProfilerConfig(tableId);

# Get profiler config
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}"

# Set profiler config
curl -X PUT "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "profileSample": 50,
    "profileSampleType": "PERCENTAGE",
    "sampleDataCount": 200,
    "excludeColumns": ["performance_score"]
  }'

# Delete profiler config
curl -X DELETE "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/profilerConfig" \
  -H "Authorization: Bearer {access_token}"

# Get table profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/tableProfile" \
  -H "Authorization: Bearer {access_token}"

# Get column profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/columnProfile" \
  -H "Authorization: Bearer {access_token}"

# Get system profile
curl "{base_url}/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3/systemProfile" \
  -H "Authorization: Bearer {access_token}"

{
  "profileSample": 50,
  "profileSampleType": "PERCENTAGE",
  "sampleDataCount": 200,
  "excludeColumns": ["created_at"]
}

Returns

Get profiler config returns the profiler configuration object. Set profiler config returns the updated profiler configuration. Delete profiler config returns no content (204). Get table profile returns table-level metrics (row count, size, etc.). Get column profile returns column-level metrics (min, max, mean, null count, distinct count, etc.). Get system profile returns system-level metrics (DML operations, rows affected, etc.).

Response (Profiler Config)

number

Sample size for profiling.

string

Type of sample: PERCENTAGE or ROWS.

integer

Number of sample data rows to collect.

string

Custom SQL query used for profiling.

array

Columns excluded from profiling.

array

Column-level profiler configurations.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission
`404`	`NOT_FOUND`	Table does not exist or has no profiler config

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Table Profiler

Table Profiler

Get Profiler Config

Set Profiler Config

Delete Profiler Config

Get Table Profile

Get Column Profile

Get System Profile

Returns

Response (Profiler Config)

Error Handling

​Table Profiler

​Get Profiler Config

​Set Profiler Config

​Delete Profiler Config

​Get Table Profile

​Get Column Profile

​Get System Profile

​Returns

​Response (Profiler Config)

​Error Handling

Table Profiler

Get Profiler Config

Set Profiler Config

Delete Profiler Config

Get Table Profile

Get Column Profile

Get System Profile

Returns

Response (Profiler Config)

Error Handling