Optional filterOptional filterFilter by logical experiment name. This is the name field set when creating an experiment through POST /experiments. Returns all experiment runs that share the same name, enabling cross-commit and cross-branch comparisons.
Optional filterFilter experiments by experiment ID. Can be specified multiple times.
Optional filterWhen true, return only soft-deleted experiments. Defaults to false.
Optional filterFilter by JSONB metadata containment. Provide a JSON object string where
experiments whose metadata contains all specified key-value pairs are returned.
For example: {"commit":"abc123","branch":"main"}.
Optional filterFilter experiments by their exact run name.
Optional filterFilter experiments by the ID of their parent (baseline) experiment. Returns all experiments that were run against the given baseline. Can be specified multiple times.
Optional filterFilter experiments by project ID. Required if filter[dataset_id] is not provided.
Optional includeWhen true, enrich each experiment with its dataset name in the dataset_name field.
Optional includeWhen true, enrich each experiment with its author's user data in the author field.
Optional pageUse the pagination cursor returned in meta.after to retrieve the next page of results.
Optional pageMaximum number of results to return per page. Values above 5000 are clamped to 5000. Defaults to 5000.
Generated using TypeDoc
Filter experiments by dataset ID.