Skip to content
Book a demo

Connect documentation

All documentation
Documentation

Acknowledging and reopening Data Quality issues

On this page

This guide explains how to acknowledge and reopen Data Quality issues, mark an issue as expected, and accept a column structure change into the baseline using Connect API. For prerequisites, limitations, and how to select workspaces and list issues, see Managing Data Quality issues.

Acknowledging and reopening issues

To acknowledge issues, or to reopen acknowledged issues, follow these steps:

  1. Create a POST request to one of the following endpoints:

    • To acknowledge issues:

      https://{{INSTANCE}}/api/v1/monitors/issues/acknowledge/
      
    • To reopen acknowledged issues:

      https://{{INSTANCE}}/api/v1/monitors/issues/unacknowledge/
      
  2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

  3. In the HTTP request header, include the parameter Content-Type with value application/json.

  4. Select the issues in one of the following ways:

    • To select specific issues, in the HTTP request body, include issue_ids with a list of up to 50 issue IDs.

    • To select every issue of one or more workspaces, add the workspace_scope and scope_from_workspace_id query parameters, and send an empty JSON object ({}) as the request body. For more information, see Selecting workspaces.

    If you use both, only the listed issues in the selected workspaces change. If you use neither, Connect API returns HTTP 400.

  5. Send the request.

As a result, the selected issues are acknowledged or reopened. The response lists the issues that changed:

{
  "affected": {
    "issue_ids": [81234, 81240]
  }
}

Issues that the key cannot see, IDs that are not issues, and issues that are already acknowledged or open are left out of the response. Repeating the request returns an empty list.

The cURL request example is the following:

curl --location --request POST 'https://{{INSTANCE}}/api/v1/monitors/issues/acknowledge/' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data '{"issue_ids": [81234, 81240]}'

To acknowledge every issue of one workspace and the workspaces below it, use the following cURL request:

curl --location --request POST 'https://{{INSTANCE}}/api/v1/monitors/issues/acknowledge/?workspace_scope=descendants&scope_from_workspace_id={{WORKSPACE_ID}}' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data '{}'

Acknowledging and reopening the issues of a job group

To acknowledge or reopen the issues raised by the fetch of one job group, follow these steps:

  1. Create a POST request to one of the following endpoints:

    • To acknowledge issues:

      https://{{INSTANCE}}/api/v1/monitors/issues/job-groups/{{JOB_GROUP_ID}}/acknowledge/
      
    • To reopen acknowledged issues:

      https://{{INSTANCE}}/api/v1/monitors/issues/job-groups/{{JOB_GROUP_ID}}/unacknowledge/
      

    Replace {{JOB_GROUP_ID}} with the numeric ID of the job group, for example the job_group_id of an issue. See the note at the end of this section for issues that carry a job_group_id but are not selected.

  2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

  3. In the HTTP request header, include the parameter Content-Type with value application/json.

  4. In the HTTP request body, include any of the following:

    • issue_ids with a list of up to 50 issue IDs of the job group to select only these issues.

    • exclude_issue_ids with a list of up to 50 issue IDs to leave out of the selection.

    To select every issue of the job group, send an empty JSON object ({}).

  5. Send the request.

As a result, the selected issues of the job group are acknowledged or reopened, and the response lists the issues that changed, as described in Acknowledging and reopening issues. A job group with more than 1000 issues to change returns HTTP 400; select the issues with issue_ids instead.

The cURL request example is the following. It acknowledges every issue of the job group except one:

curl --location --request POST 'https://{{INSTANCE}}/api/v1/monitors/issues/job-groups/{{JOB_GROUP_ID}}/acknowledge/' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data '{"exclude_issue_ids": [81240]}'

Marking an issue as expected

You can record whether an issue of a universal monitor was expected, for example a volume drop during a planned campaign pause.

To mark an issue as expected, follow these steps:

  1. Create a PUT request to the following endpoint:

    https://{{INSTANCE}}/api/v1/monitors/issues/{{ISSUE_ID}}/expected/
    

    Replace {{ISSUE_ID}} with the id of the issue.

  2. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

  3. In the HTTP request header, include the parameter Content-Type with value application/json.

  4. In the HTTP request body, include expected with value true if the issue was expected, or false if it was not.

  5. Send the request.

As a result, the expected field of the issue is updated, and the response contains the issue.

The issues of custom monitors (type values) do not record this value: for them, Connect API returns HTTP 400.

The cURL request example is the following:

curl --location --request PUT 'https://{{INSTANCE}}/api/v1/monitors/issues/{{ISSUE_ID}}/expected/' \
--header 'Authorization: Bearer {{KEY}}' \
--header 'Content-Type: application/json' \
--data '{"expected": true}'

Accepting a column structure change into the baseline

When the column consistency monitor reports an issue because the columns of a data extract changed on purpose, you can make the new column structure the baseline of the datastream. For more information on the baseline, see Updating the baseline of the column consistency monitor.

To accept the column structure of an issue into the baseline, follow these steps:

  1. (Optional) Check the change. Read the details of the issue as described in Reading the details of an issue, and compare extract_schema with baseline_schema, or read diff.

  2. Create a POST request to the following endpoint:

    https://{{INSTANCE}}/api/v1/monitors/issues/{{ISSUE_ID}}/apply-schema/
    

    Replace {{ISSUE_ID}} with the id of an issue of type schema_consistency.

  3. In the HTTP request header, include the parameter Authorization with value Bearer {{KEY}}.

  4. Send the request.

As a result, the column structure of the issue’s data extract becomes the baseline of the datastream, and the issue is acknowledged. The response contains the new baseline: its schema_columns, when it was changed (updated), updated_by, which is the user the API key belongs to, and extract_id. Unlike the extract_id of an issue, this is the UUID of the data extract the issue was found on. It is null if that data extract was deleted or has no UUID.

Connect API returns HTTP 404 if the issue does not exist, the key cannot see it, it is not of type schema_consistency, or the datastream has no baseline. It returns HTTP 400 if the issue did not record the columns of its data extract.

The cURL request example is the following:

curl --location --request POST 'https://{{INSTANCE}}/api/v1/monitors/issues/{{ISSUE_ID}}/apply-schema/' \
--header 'Authorization: Bearer {{KEY}}'