GET https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/traffic-summary https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/traffic-summary https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/traffic-summary https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/traffic-summary https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/traffic-summary https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/traffic-summary https://api.datadoghq.com/api/v2/experiments/{experiment_id}/traffic-summary https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/traffic-summary https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/traffic-summary
Overview Get an experiment’s traffic summary: per-variant exposure counts and a sample-ratio-mismatch flag (is_traffic_imbalanced). SRM statistics live on the diagnostics endpoint.
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 experiment traffic summary.
Expand All
JSON:API resource containing the experiment traffic summary identity and fields.
Details of the experiment traffic summary.
Whether the observed variant traffic is imbalanced.
Total number of subjects included in the traffic summary.
Exposure counts for each experiment variant.
Number of recorded exposures for this variant.
Key that identifies the experiment variant.
Display name of the experiment variant.
Identifier of this traffic summary.
Traffic summary resource type.
Allowed enum values: traffic-summary
default: traffic-summary
{
"data" : {
"attributes" : {
"is_traffic_imbalanced" : false ,
"total_subjects" : "integer" ,
"variants" : [
{
"exposure_count" : "integer" ,
"variant_key" : "string" ,
"variant_name" : "string"
}
]
},
"id" : "traffic-summary-1785542400000-1785628800000" ,
"type" : "traffic-summary"
}
} Malformed experiment ID (not a valid UUID), or the experiment is not configured for analysis.
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.
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"
}
]
} The experiment's metrics are incompatible with analysis.
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}/traffic-summary " \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN} " 
