GET https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/diagnostics https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/diagnostics https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/diagnostics https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics https://api.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/diagnostics 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 to access this endpoint.
Arguments Path Parameters The UUID of the experiment.
Response OK
Response containing the diagnostic checks for an experiment.
Expand All
Experiment diagnostics resource with its identifier and check results.
Diagnostic check results and their evaluation state.
Results of individual diagnostic checks.
Explanation of the diagnostic check result.
Identifier of the metric associated with this check.
Reason the diagnostic check could not be evaluated.
Allowed enum values: NO_ASSIGNMENTS,NO_DIMENSIONAL_DATA,NO_METRIC_DATA,ZERO_VARIANCE
Outcome of an individual diagnostic check.
Allowed enum values: PASS,FAIL,WARN,ERROR,SKIPPED
Short title of the diagnostic check.
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_DEGRADATIONShow 6 more ,PIPELINE_STATUS,MAPPED_ANALYSIS_CONFIGURATION,MAPPED_ANALYSIS_COVERAGE,MAPPED_ANALYSIS_COLLISIONS,MAPPED_ANALYSIS_FANOUT,MAPPED_ANALYSIS_CHANGE
Time when the diagnostic checks were evaluated.
Overall result of the experiment diagnostic checks.
Allowed enum values: PASS,FAIL,WARN,NO_DATA
Current state of the diagnostic evaluation.
Allowed enum values: NOT_STARTED,RUNNING,COMPLETED,FAILED
Identifier of the experiment whose diagnostics are returned.
Experiment diagnostics resource type.
Allowed enum values: experiment-diagnostics
default: experiment-diagnostics
{
"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"
}
} Malformed experiment ID (not a valid UUID).
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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"
}
]
} Missing or invalid authentication.
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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"
}
]
} Authenticated caller lacks the product_analytics_experiments_read permission.
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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"
}
]
} 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.
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Path parameters export experiment_id = "550e8400-e29b-41d4-a716-446655440000" # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN = "<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" # 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/experiments/${experiment_id}/diagnostics " \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN} " 
