List experiments. Returns a paginated list of experiments and their structured metadata for the organization. Supports filtering and pagination. Use Get experiment for variants, decision metrics, traffic exposure, and assignment configuration.
This endpoint requires the product_analytics_experiments_read permission.
OAuth apps require the product_analytics_experiments_read authorization scope to access this endpoint.
Arguments
Query Strings
Name
Type
Description
concluded_since
string
Return only experiments concluded at or after this RFC3339 timestamp. Inclusive, and excludes experiments that have not concluded.
created_since
string
Return only experiments created at or after this RFC3339 timestamp. Inclusive.
page[limit]
integer
Maximum number of results to return. Defaults to 25 when omitted, and is capped at 50 (larger values are clamped to 50). The response includes meta.page (with total) and pagination links.
page[offset]
integer
Number of results to skip for pagination. Defaults to 0 when omitted.
protocol_id
array
Filter by protocol UUID. Repeat this parameter to supply several IDs. An experiment matches if it uses any
listed protocol.
results_updated_before
string
Return only experiments whose results_last_updated is before this RFC3339 timestamp. results_last_updated is the later of the latest successful run completion and the latest stored result refresh. Exclusive, and excludes experiments without successful results.
results_updated_since
string
Return only experiments whose results_last_updated is at or after this RFC3339 timestamp. results_last_updated is the later of the latest successful run completion and the latest stored result refresh. Inclusive, and excludes experiments without successful results. This filter does not include all metadata edits or deletions.
search
string
Find experiments whose names contain the search text, regardless of case.
sort
string
Sort fields: name, created_at, or updated_at. Use a comma-separated list in priority order, for example name,-created_at. Prefix each field with - for descending. Defaults to created_at descending.
status
array
Filter by experiment status. Accepted values are DRAFT, SCHEDULED, IN_PROGRESS, READY_FOR_DECISION,
DECISION_MADE, and CANCELLED. Repeat this parameter to select several statuses, for example
status=IN_PROGRESS&status=READY_FOR_DECISION.
tags
array
Filter by tag name. Repeat this parameter to supply several tags. An experiment matches if it has at least
one listed tag.
Response containing a page of experiment summaries.
Expand All
Field
Type
Description
data [required]
[object]
Experiment summaries in the current page.
attributes
object
Summary fields for an experiment returned in a list.
assignments_end_date
date-time
End of the window used to read experiment assignments.
assignments_start_date
date-time
Start of the window used to read experiment assignments.
concluded_at
date-time
Time when the experiment was concluded.
conclusion
object
Outcome and supporting text recorded when the experiment is concluded.
decision_reason
string
Reason for the recorded decision.
outcome
enum
Recorded experiment outcome.
Allowed enum values: POSITIVE,NEGATIVE,NEUTRAL,INCONCLUSIVE,MISCONFIGURED,UNKNOWN
summary
string
Summary of the experiment conclusion.
created_at
date-time
Time when the experiment was created.
events_end_date
date-time
End of the window used to read metric events.
events_start_date
date-time
Start of the window used to read metric events.
experiment_type
string
Kind of experiment. STANDARD is an ordinary experiment. Other values, such as CANARY and HOLDOUT, identify experiments owned by another workflow. New kinds may be added; treat unknown values as non-standard.
hypothesis
string
Expected effect that the experiment is designed to test.
migration_metadata
Metadata associated with migration of this resource.
name
string
Display name of the experiment.
pipeline_table_suffix
string
Suffix used for the experiment tables in the analysis pipeline.
protocol_id
string
Identifier of the protocol associated with the experiment.
related_links
[object]
External links associated with the experiment.
id
string
Link ID. Omit it when adding a link.
title
string
Optional display title.
url [required]
string
Absolute URL.
results_last_updated
date-time
Time when the experiment results were last updated.
status
enum
Current stage in the experiment lifecycle.
Allowed enum values: DRAFT,SCHEDULED,IN_PROGRESS,READY_FOR_DECISION,DECISION_MADE,CANCELLED,UNKNOWN
structured_metadata
[object]
Custom metadata fields and their values for the experiment.
enum_values
[string]
Selected values for an enumerated metadata field.
field_display_name
string
Display name of the metadata field.
field_key [required]
string
Key that identifies the metadata field.
field_type
enum
Type of value stored in the structured metadata field.
Allowed enum values: FREETEXT,ENUM
freetext_value
string
Text value for a free-text metadata field.
subject_type_id
string
Identifier of the subject type used for experiment assignments.
Invalid query parameter: bad page[offset]/page[limit], unknown sort field, invalid status, malformed protocol_id UUID, invalid result timestamp range, or a timestamp filter that is not RFC3339.
