--- title: Get a tag policy compliance score description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Tag Policies --- # Get a tag policy compliance score{% #get-a-tag-policy-compliance-score %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/tag-policies/{policy_id}/score | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/tag-policies/{policy_id}/score | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/tag-policies/{policy_id}/score | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/tag-policies/{policy_id}/score | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/tag-policies/{policy_id}/score | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/tag-policies/{policy_id}/score | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/tag-policies/{policy_id}/score | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/tag-policies/{policy_id}/score | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/tag-policies/{policy_id}/score | ### Overview Retrieve the compliance score for a single tag policy. The score is computed over the requested time window (or a source-appropriate default) and represents the percentage of telemetry within that window that conforms to the policy. A `null` score indicates that no relevant telemetry was found. ### Arguments #### Path Parameters | Name | Type | Description | | --------------------------- | ------ | ---------------------------------------- | | policy_id [*required*] | string | The unique identifier of the tag policy. | #### Query Strings | Name | Type | Description | | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | ts_start | integer | Start of the time window used for compliance score computation, as a Unix timestamp in milliseconds. | | ts_end | integer | End of the time window used for compliance score computation, as a Unix timestamp in milliseconds. Must be in the past and greater than `ts_start`. | ### Response {% tab title="200" %} OK {% tab title="Model" %} A tag policy compliance score. | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | A compliance score resource for a tag policy. | | data | attributes [*required*] | object | Attributes of a tag policy compliance score. | | attributes | score [*required*] | double | The compliance score for the policy over the requested time window, as a percentage between 0 and 100. `null` indicates that no relevant telemetry was found. | | attributes | ts_end [*required*] | int64 | End of the time window the score was computed over, as a Unix timestamp in milliseconds. | | attributes | ts_start [*required*] | int64 | Start of the time window the score was computed over, as a Unix timestamp in milliseconds. | | attributes | version [*required*] | int64 | The version of the tag policy that the score was computed against. | | data | id [*required*] | string | The unique identifier of the compliance score resource. | | data | type [*required*] | enum | JSON:API resource type for a tag policy compliance score. Allowed enum values: `tag_policy_score` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "score": 80, "ts_end": 1779401466097, "ts_start": 1779315066097, "version": 1 }, "id": "123-v1-1779315066097-1779401466097", "type": "tag_policy_score" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export policy_id="123" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/tag-policies/${policy_id}/score" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get a tag policy compliance score returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.tag_policies_api import TagPoliciesApi configuration = Configuration() configuration.unstable_operations["get_tag_policy_score"] = True with ApiClient(configuration) as api_client: api_instance = TagPoliciesApi(api_client) response = api_instance.get_tag_policy_score( policy_id="policy_id", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get a tag policy compliance score returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.get_tag_policy_score".to_sym] = true end api_instance = DatadogAPIClient::V2::TagPoliciesAPI.new p api_instance.get_tag_policy_score("policy_id") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get a tag policy compliance score returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetTagPolicyScore", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewTagPoliciesApi(apiClient) resp, r, err := api.GetTagPolicyScore(ctx, "policy_id", *datadogV2.NewGetTagPolicyScoreOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TagPoliciesApi.GetTagPolicyScore`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `TagPoliciesApi.GetTagPolicyScore`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get a tag policy compliance score returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.TagPoliciesApi; import com.datadog.api.client.v2.model.TagPolicyScoreResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.getTagPolicyScore", true); TagPoliciesApi apiInstance = new TagPoliciesApi(defaultClient); try { TagPolicyScoreResponse result = apiInstance.getTagPolicyScore("123"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TagPoliciesApi#getTagPolicyScore"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get a tag policy compliance score returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_tag_policies::GetTagPolicyScoreOptionalParams; use datadog_api_client::datadogV2::api_tag_policies::TagPoliciesAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.GetTagPolicyScore", true); let api = TagPoliciesAPI::with_config(configuration); let resp = api .get_tag_policy_score( "policy_id".to_string(), GetTagPolicyScoreOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get a tag policy compliance score returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.getTagPolicyScore"] = true; const apiInstance = new v2.TagPoliciesApi(configuration); const params: v2.TagPoliciesApiGetTagPolicyScoreRequest = { policyId: "policy_id", }; apiInstance .getTagPolicyScore(params) .then((data: v2.TagPolicyScoreResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}