Overview
Theget
method allows you to retrieve detailed information about a specific experiment, including its configuration, variants, current status, and results.
Method Signature
Synchronous
Asynchronous
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
experiment_id | str | Yes | The unique identifier of the experiment |
Returns
Returns a dictionary containing detailed experiment information including configuration, variants, metrics, and current status.Examples
Basic Retrieval
Accessing Experiment Details
Checking Experiment Status
Analyzing Experiment Configuration
Error Handling for Missing Experiments
Asynchronous Usage
Accessing Current Results
Batch Retrieval
Asynchronous Batch Retrieval
Experiment Validation
Export Experiment Details
Error Handling
Experiment Structure
A retrieved experiment contains:id
: Unique experiment identifiername
: Experiment namedescription
: Optional descriptionstatus
: Current status (draft, running, completed, paused)variants
: List of variants being testedmetrics
: Metrics being trackedtraffic_split
: Traffic distribution between variantscreated_at
: Creation timestampcreated_by
: User who created the experimentstarted_at
: When experiment was started (if applicable)completed_at
: When experiment was completed (if applicable)current_results
: Current performance data (if running/completed)metadata
: Custom metadata
Best Practices
- Always handle the case where an experiment might not exist
- Check experiment status before performing status-dependent operations
- Validate experiment configuration before starting
- Use async methods for better performance when retrieving multiple experiments
- Cache experiment data when appropriate to reduce API calls
Common Use Cases
- Displaying experiment details in a dashboard
- Validating experiment configuration before starting
- Monitoring experiment progress and results
- Exporting experiment data for analysis
- Checking experiment status before performing operations
- Retrieving experiment metadata for reporting