--- title: Get experiment diagnostics description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Experiments --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Get experiment diagnostics{% #get-experiment-diagnostics %} {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/diagnostics | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/diagnostics | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/diagnostics | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics | ### Overview Get the diagnostics produced by an experiment's latest analysis run. Each diagnostic includes its category, and the response includes an overall diagnostic or pipeline lifecycle status. This endpoint requires the `product_analytics_experiments_read` permission. OAuth apps require the `product_analytics_experiments_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#experiments) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------- | ------ | --------------------------- | | experiment_id [*required*] | string | The UUID of the experiment. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing the diagnostic checks for an experiment. | Parent field | Field | Type | Description | | ------------ | ----------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Experiment diagnostics resource with its identifier and check results. | | data | attributes | object | Diagnostic check results and their evaluation state. | | attributes | diagnostics [*required*] | [object] | Results of individual diagnostic checks. | | diagnostics | message | string | Explanation of the diagnostic check result. | | diagnostics | metric_id | string | Identifier of the metric associated with this check. | | diagnostics | skipped_reason | enum | Reason the diagnostic check could not be evaluated. Allowed enum values: `NO_ASSIGNMENTS,NO_DIMENSIONAL_DATA,NO_METRIC_DATA,ZERO_VARIANCE` | | diagnostics | status [*required*] | enum | Outcome of an individual diagnostic check. Allowed enum values: `PASS,FAIL,WARN,ERROR,SKIPPED` | | diagnostics | title [*required*] | string | Short title of the diagnostic check. | | diagnostics | type [*required*] | enum | Kind of diagnostic check performed. Allowed enum values: `EXPERIMENT_HAS_ASSIGNMENTS,METRIC_HAS_DATA,ASSIGNMENT_IMBALANCE,METRIC_WINSORIZE_ZERO,PRE_EXPERIMENT_IMBALANCE,MIXED_ASSIGNMENTS,DIMENSIONAL_ASSIGNMENT_IMBALANCE,FLAG_HAS_EVALUATIONS,IMPLAUSIBLE_PRIOR,DIMENSIONAL_DEGRADATION` | | attributes | evaluated_at | date-time | Time when the diagnostic checks were evaluated. | | attributes | result | enum | Overall result of the experiment diagnostic checks. Allowed enum values: `PASS,FAIL,WARN,NO_DATA` | | attributes | state [*required*] | enum | Current state of the diagnostic evaluation. Allowed enum values: `NOT_STARTED,RUNNING,COMPLETED,FAILED` | | data | id [*required*] | uuid | Identifier of the experiment whose diagnostics are returned. | | data | type [*required*] | enum | Experiment diagnostics resource type. Allowed enum values: `experiment-diagnostics` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "diagnostics": [ { "message": "string", "metric_id": "string", "skipped_reason": "string", "status": "PASS", "title": "title", "type": "EXPERIMENT_HAS_ASSIGNMENTS" } ], "evaluated_at": "2019-09-19T10:00:00.000Z", "result": "string", "state": "NOT_STARTED" }, "id": "550e8400-e29b-41d4-a716-446655440000", "type": "experiment-diagnostics" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Malformed experiment ID (not a valid UUID). {% 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" %} Missing or invalid authentication. {% 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" %} Authenticated caller lacks the product_analytics_experiments_read permission. {% 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" %} No experiment with this ID exists for the organization. Lifecycle statuses in a successful response explain whether analysis has started, is running, or completed without diagnostics. {% 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 experiment_id="550e8400-e29b-41d4-a716-446655440000" \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/experiments/${experiment_id}/diagnostics" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ##### ```python """ Get experiment diagnostics returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.experiments_api import ExperimentsApi # there is a valid "experiment" in the system EXPERIMENT_DATA_ID = environ["EXPERIMENT_DATA_ID"] configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = ExperimentsApi(api_client) response = api_instance.get_experiment_diagnostics( experiment_id=EXPERIMENT_DATA_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_BEARER_TOKEN="" python3 "example.py" ##### ```ruby # Get experiment diagnostics returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::ExperimentsAPI.new # there is a valid "experiment" in the system EXPERIMENT_DATA_ID = ENV["EXPERIMENT_DATA_ID"] p api_instance.get_experiment_diagnostics(EXPERIMENT_DATA_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_BEARER_TOKEN="" rb "example.rb" ##### ```go // Get experiment diagnostics 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" "github.com/google/uuid" ) func main() { // there is a valid "experiment" in the system ExperimentDataID := uuid.MustParse(os.Getenv("EXPERIMENT_DATA_ID")) ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewExperimentsApi(apiClient) resp, r, err := api.GetExperimentDiagnostics(ctx, ExperimentDataID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ExperimentsApi.GetExperimentDiagnostics`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ExperimentsApi.GetExperimentDiagnostics`:\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_BEARER_TOKEN="" go run "main.go" ##### ```java // Get experiment diagnostics returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ExperimentsApi; import com.datadog.api.client.v2.model.ExperimentsExperimentDiagnosticsV2DTO; import java.util.UUID; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); ExperimentsApi apiInstance = new ExperimentsApi(defaultClient); // there is a valid "experiment" in the system UUID EXPERIMENT_DATA_ID = null; try { EXPERIMENT_DATA_ID = UUID.fromString(System.getenv("EXPERIMENT_DATA_ID")); } catch (IllegalArgumentException e) { System.err.println("Error parsing UUID: " + e.getMessage()); } try { ExperimentsExperimentDiagnosticsV2DTO result = apiInstance.getExperimentDiagnostics(EXPERIMENT_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ExperimentsApi#getExperimentDiagnostics"); 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_BEARER_TOKEN="" java "Example.java" ##### ```rust // Get experiment diagnostics returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_experiments::ExperimentsAPI; #[tokio::main] async fn main() { // there is a valid "experiment" in the system let experiment_data_id = uuid::Uuid::parse_str(&std::env::var("EXPERIMENT_DATA_ID").unwrap()).expect("Invalid UUID"); let configuration = datadog::Configuration::new(); let api = ExperimentsAPI::with_config(configuration); let resp = api .get_experiment_diagnostics(experiment_data_id.clone()) .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 {% /tab %}