Table of Contents

Interface IExperimentsClient

Namespace
Auth0.ManagementApi.Experimentation
Assembly
Auth0.ManagementApi.dll
public interface IExperimentsClient
Extension Methods

Methods

AdvanceRampAsync(string, AdvanceRampRequestContent, RequestOptions?, CancellationToken)

Increments the current ramp index to the requested target level. Up-only: the target must be the immediate next level in the schedule. Idempotent: calling with the current level returns success without writing anything.

WithRawResponseTask<AdvanceRampResponseContent> AdvanceRampAsync(string id, AdvanceRampRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
request AdvanceRampRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<AdvanceRampResponseContent>

CreateAsync(CreateExperimentRequestContent, RequestOptions?, CancellationToken)

Create a new experiment for A/B testing.

WithRawResponseTask<CreateExperimentResponseContent> CreateAsync(CreateExperimentRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateExperimentRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateExperimentResponseContent>

DeleteAsync(string, RequestOptions?, CancellationToken)

Permanently delete an experiment and its allocations by ID. Active experiments cannot be deleted; pause or complete first. Idempotent: returns 204 even if the experiment does not exist.

WithRawResponseTask DeleteAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve a single experiment with its allocations by ID.

WithRawResponseTask<GetExperimentResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetExperimentResponseContent>

ListAsync(ListExperimentsRequestParameters, RequestOptions?, CancellationToken)

Retrieve a paginated list of experiments for the tenant, with optional filters.

Task<Pager<ExperimentListItem>> ListAsync(ListExperimentsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListExperimentsRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<ExperimentListItem>>

UpdateAsync(string, UpdateExperimentRequestParameters, RequestOptions?, CancellationToken)

Partially update an experiment by ID. Only provided fields are updated. Providing allocations replaces the entire allocations set.

WithRawResponseTask<UpdateExperimentResponseContent> UpdateAsync(string id, UpdateExperimentRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
request UpdateExperimentRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateExperimentResponseContent>

ValidateAsync(string, RequestOptions?, CancellationToken)

Checks whether an experiment is ready to be activated. Returns is_valid boolean and an errors array describing any blockers. Read-only; no state is modified.

WithRawResponseTask<ValidateExperimentResponseContent> ValidateAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<ValidateExperimentResponseContent>