Get a tag rule compliance score

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/governance/tag_rules/{rule_id}/scorehttps://api.ap2.datadoghq.com/api/v2/governance/tag_rules/{rule_id}/scorehttps://api.datadoghq.eu/api/v2/governance/tag_rules/{rule_id}/scorehttps://api.ddog-gov.com/api/v2/governance/tag_rules/{rule_id}/scorehttps://api.us2.ddog-gov.com/api/v2/governance/tag_rules/{rule_id}/scorehttps://api.uk1.datadoghq.com/api/v2/governance/tag_rules/{rule_id}/scorehttps://api.datadoghq.com/api/v2/governance/tag_rules/{rule_id}/scorehttps://api.us3.datadoghq.com/api/v2/governance/tag_rules/{rule_id}/scorehttps://api.us5.datadoghq.com/api/v2/governance/tag_rules/{rule_id}/score

Overview

Retrieve the compliance score for a single tag rule. 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 rule. A null score indicates that no relevant telemetry was found. This endpoint requires any of the following permissions:

  • telemetry_rules_read
  • metrics_read

  • Arguments

    Path Parameters

    Name

    Type

    Description

    rule_id [required]

    string

    The unique identifier of the tag rule.

    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

    OK

    A tag rule compliance score.

    Expand All

    Field

    Type

    Description

    data [required]

    object

    A compliance score resource for a tag rule.

    attributes [required]

    object

    Attributes of a tag rule compliance score.

    score [required]

    double

    The compliance score for the rule over the requested time window, as a percentage between 0 and 100. null indicates that no relevant telemetry was found.

    ts_end [required]

    int64

    End of the time window the score was computed over, as a Unix timestamp in milliseconds.

    ts_start [required]

    int64

    Start of the time window the score was computed over, as a Unix timestamp in milliseconds.

    version [required]

    int64

    The version of the tag rule that the score was computed against.

    id [required]

    string

    The unique identifier of the compliance score resource.

    type [required]

    enum

    JSON:API resource type for a tag rule compliance score. Allowed enum values: tag_rule_score

    {
      "data": {
        "attributes": {
          "score": 80,
          "ts_end": 1779401466097,
          "ts_start": 1779315066097,
          "version": 1
        },
        "id": "123-v1-1779315066097-1779401466097",
        "type": "tag_rule_score"
      }
    }

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
      "errors": [
        {
          "detail": "Missing required attribute in body",
          "meta": {},
          "source": {
            "header": "Authorization",
            "parameter": "limit",
            "pointer": "/data/attributes/title"
          },
          "status": "400",
          "title": "Bad Request"
        }
      ]
    }

    Unauthorized

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
      "errors": [
        {
          "detail": "Missing required attribute in body",
          "meta": {},
          "source": {
            "header": "Authorization",
            "parameter": "limit",
            "pointer": "/data/attributes/title"
          },
          "status": "400",
          "title": "Bad Request"
        }
      ]
    }

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
      "errors": [
        {
          "detail": "Missing required attribute in body",
          "meta": {},
          "source": {
            "header": "Authorization",
            "parameter": "limit",
            "pointer": "/data/attributes/title"
          },
          "status": "400",
          "title": "Bad Request"
        }
      ]
    }

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
      "errors": [
        {
          "detail": "Missing required attribute in body",
          "meta": {},
          "source": {
            "header": "Authorization",
            "parameter": "limit",
            "pointer": "/data/attributes/title"
          },
          "status": "400",
          "title": "Bad Request"
        }
      ]
    }

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Code Example

                      # Path parameters
    export rule_id="123"
    # Curl command
    curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/governance/tag_rules/${rule_id}/score" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
    """
    Get a tag rule compliance score returns "OK" response
    """
    
    from datadog_api_client import ApiClient, Configuration
    from datadog_api_client.v2.api.tag_rules_api import TagRulesApi
    
    configuration = Configuration()
    configuration.unstable_operations["get_tag_rule_score"] = True
    with ApiClient(configuration) as api_client:
        api_instance = TagRulesApi(api_client)
        response = api_instance.get_tag_rule_score(
            rule_id="rule_id",
        )
    
        print(response)
    

    Instructions

    First install the library and its dependencies and then save the example to example.py and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
    # Get a tag rule compliance score returns "OK" response
    
    require "datadog_api_client"
    DatadogAPIClient.configure do |config|
      config.unstable_operations["v2.get_tag_rule_score".to_sym] = true
    end
    api_instance = DatadogAPIClient::V2::TagRulesAPI.new
    p api_instance.get_tag_rule_score("rule_id")
    

    Instructions

    First install the library and its dependencies and then save the example to example.rb and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
    // Get a tag rule 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.GetTagRuleScore", true)
    	apiClient := datadog.NewAPIClient(configuration)
    	api := datadogV2.NewTagRulesApi(apiClient)
    	resp, r, err := api.GetTagRuleScore(ctx, "rule_id", *datadogV2.NewGetTagRuleScoreOptionalParameters())
    
    	if err != nil {
    		fmt.Fprintf(os.Stderr, "Error when calling `TagRulesApi.GetTagRuleScore`: %v\n", err)
    		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    	}
    
    	responseContent, _ := json.MarshalIndent(resp, "", "  ")
    	fmt.Fprintf(os.Stdout, "Response from `TagRulesApi.GetTagRuleScore`:\n%s\n", responseContent)
    }
    

    Instructions

    First install the library and its dependencies and then save the example to main.go and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
    // Get a tag rule compliance score returns "OK" response
    
    import com.datadog.api.client.ApiClient;
    import com.datadog.api.client.ApiException;
    import com.datadog.api.client.v2.api.TagRulesApi;
    import com.datadog.api.client.v2.model.TagRuleScoreResponse;
    
    public class Example {
      public static void main(String[] args) {
        ApiClient defaultClient = ApiClient.getDefaultApiClient();
        defaultClient.setUnstableOperationEnabled("v2.getTagRuleScore", true);
        TagRulesApi apiInstance = new TagRulesApi(defaultClient);
    
        try {
          TagRuleScoreResponse result = apiInstance.getTagRuleScore("123");
          System.out.println(result);
        } catch (ApiException e) {
          System.err.println("Exception when calling TagRulesApi#getTagRuleScore");
          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 and then save the example to Example.java and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
    // Get a tag rule compliance score returns "OK" response
    use datadog_api_client::datadog;
    use datadog_api_client::datadogV2::api_tag_rules::GetTagRuleScoreOptionalParams;
    use datadog_api_client::datadogV2::api_tag_rules::TagRulesAPI;
    
    #[tokio::main]
    async fn main() {
        let mut configuration = datadog::Configuration::new();
        configuration.set_unstable_operation_enabled("v2.GetTagRuleScore", true);
        let api = TagRulesAPI::with_config(configuration);
        let resp = api
            .get_tag_rule_score(
                "rule_id".to_string(),
                GetTagRuleScoreOptionalParams::default(),
            )
            .await;
        if let Ok(value) = resp {
            println!("{:#?}", value);
        } else {
            println!("{:#?}", resp.unwrap_err());
        }
    }
    

    Instructions

    First install the library and its dependencies and then save the example to src/main.rs and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
    /**
     * Get a tag rule compliance score returns "OK" response
     */
    
    import { client, v2 } from "@datadog/datadog-api-client";
    
    const configuration = client.createConfiguration();
    configuration.unstableOperations["v2.getTagRuleScore"] = true;
    const apiInstance = new v2.TagRulesApi(configuration);
    
    const params: v2.TagRulesApiGetTagRuleScoreRequest = {
      ruleId: "rule_id",
    };
    
    apiInstance
      .getTagRuleScore(params)
      .then((data: v2.TagRuleScoreResponse) => {
        console.log(
          "API called successfully. Returned data: " + JSON.stringify(data)
        );
      })
      .catch((error: any) => console.error(error));
    

    Instructions

    First install the library and its dependencies and then save the example to example.ts and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"