> For the complete documentation index, see [llms.txt](https://docs.telm.ai/telmai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.telm.ai/telmai/api-reference/dq-score-api.md).

# DQ Score

## Get DQ Score Options

<mark style="color:blue;">`GET`</mark> `https://{telmai_endpoint}/api/backend/{tenant}/configuration/assets/{assetId}/dq_score`

This endpoint retrieves the current Data Quality Score configuration for a specific asset.

### Path Parameters

| Name                                        | Type   | Description       |
| ------------------------------------------- | ------ | ----------------- |
| `tenant`<mark style="color:red;">\*</mark>  | string | Tenant identifier |
| `assetId`<mark style="color:red;">\*</mark> | string | Asset identifier  |

### Response

**200** DQ Score configuration retrieved successfully

```json
{
  "dq_score_config": {
    "enabled": true,
    "weights": {
      "completeness": 0.25,
      "accuracy": 0.25,
      "consistency": 0.25,
      "timeliness": 0.25
    }
  }
}
```

## Update DQ Score Options

<mark style="color:orange;">`PUT`</mark> `https://{telmai_endpoint}/api/backend/{tenant}/configuration/assets/{assetId}/dq_score`

This endpoint updates the Data Quality Score configuration for a specific asset.

### Path Parameters

| Name                                        | Type   | Description       |
| ------------------------------------------- | ------ | ----------------- |
| `tenant`<mark style="color:red;">\*</mark>  | string | Tenant identifier |
| `assetId`<mark style="color:red;">\*</mark> | string | Asset identifier  |

### Request Body

```json
{
  "enabled": true,
  "weights": {
    "completeness": 0.3,
    "accuracy": 0.3,
    "consistency": 0.2,
    "timeliness": 0.2
  }
}
```

### Response

**200** DQ Score configuration updated successfully

```json
{
  "dq_score_config": {
    "enabled": true,
    "weights": {
      "completeness": 0.3,
      "accuracy": 0.3,
      "consistency": 0.2,
      "timeliness": 0.2
    }
  }
}
```

## Delete DQ Score Options

<mark style="color:red;">`DELETE`</mark> `https://{telmai_endpoint}/api/backend/{tenant}/configuration/assets/{assetId}/dq_score`

This endpoint deletes the DQ Score configuration for a specific asset, reverting to default settings.

### Path Parameters

| Name                                        | Type   | Description       |
| ------------------------------------------- | ------ | ----------------- |
| `tenant`<mark style="color:red;">\*</mark>  | string | Tenant identifier |
| `assetId`<mark style="color:red;">\*</mark> | string | Asset identifier  |

### Response

**200** DQ Score configuration deleted successfully

```json
{
  "success": true,
  "message": "DQ Score configuration deleted successfully"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.telm.ai/telmai/api-reference/dq-score-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
