Sign in
latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Settings

Get global DQ settings

Returns the current value of all global DQ settings exposed on the public API.

Permissions

  • Required: DATA_QUALITY
  • Global bypass:
    • DATA_QUALITY and VIEW_PERMISSIONS_VIEW_ALL
    • DATA_QUALITY and RESOURCE_MANAGE_ALL
get/settings

Response

Settings retrieved successfully.

passingThresholdinteger required

Global passing score threshold. Scores at or above this value are considered passing (green). Must be greater than failingThreshold.

failingThresholdinteger required

Global failing score threshold. Scores below this value are considered failing (red). Must be less than passingThreshold.

lookbackLimitinteger required

Maximum number of historical rule runs used when computing DQ scores.

observationLimitinteger required

Maximum number of rows processed per rule execution.

previewLimitinteger required

Maximum number of results shown in the dataset overview and rule workbench. UI-only — does not affect what is stored. Recommended values are 25, 50, 100, 250, or 500. If a different value is provided, it is rounded to the closest recommended value.

breakRecordsLimitinteger required

Maximum number of records returned when fetching break records for a rule. UI-only — does not affect what is stored. Recommended values are 25, 50, 100, 250, or 500. If a different value is provided, it is rounded to the closest recommended value.

ruleRunTimeLimitinteger required

Maximum time in minutes a rule is allowed to run before it is automatically timed out.

jobLogRetentionHoursinteger required

Job log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).

platformLogRetentionHoursinteger required

Platform log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).

mapToPrimaryColumnboolean required

When enabled, rules are automatically mapped to the primary column of the dataset.

mandatoryPrimaryRuleColumnboolean required

When enabled, a primary column must be set on every rule before it can be saved.

mandatoryRuleDimensionboolean required

When enabled, a dimension must be assigned to every rule before it can be saved.

showDetailedExceptionboolean required

When enabled, detailed exception stack traces are included in error responses. Recommended for non-production environments only.