Overview
Thelist
method allows you to retrieve experiments with support for filtering, sorting, and pagination. This is useful for managing and reviewing your experiment portfolio.
Method Signature
Synchronous
Asynchronous
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
limit | int | No | Maximum number of experiments to return (default: 50) |
offset | int | No | Number of experiments to skip (default: 0) |
status | str | No | Filter by experiment status (draft, running, completed, paused) |
name | str | No | Filter by experiment name (partial match) |
created_by | str | No | Filter by creator user ID |
sort_by | str | No | Field to sort by (created_at, name, status) |
sort_order | str | No | Sort order (asc, desc) |
Returns
Returns a dictionary containing:experiments
: List of experiment objectstotal
: Total number of experiments matching filterslimit
: Applied limitoffset
: Applied offsethas_more
: Whether more experiments are available
Examples
Basic Usage
Pagination
Filter by Status
Filter by Name
Sorting
Combined Filtering
Filter by Creator
Asynchronous Usage
Pagination Loop
Detailed Analysis
Export Experiment List
Asynchronous Batch Processing
Error Handling
Response Structure
The response contains:Best Practices
- Use appropriate page sizes (10-50) for UI display
- Implement pagination for large experiment lists
- Filter by status to focus on relevant experiments
- Sort by creation date to see recent activity
- Cache results when appropriate to reduce API calls
- Use async methods for better performance in concurrent applications
Common Use Cases
- Dashboard displaying experiment overview
- Finding experiments by name or creator
- Monitoring running experiments
- Analyzing experiment portfolio
- Exporting experiment data
- Cleaning up old or completed experiments