Microsoft.OnlineExperimentation (preview:2025-05-31)

2025/04/21 • 5 new methods

ListMetrics (new)
Description :  Lists experiment metrics.
Reference :  Link ¶

⚼ Request

GET:  /experiment-metrics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of ExperimentMetric items ,
}
{
value:
{
Description: The ExperimentMetric items on this page ,
Required: True ,
}
[
{
id:
{
Description: Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Determines whether it is included in experiment analysis. ,
Enum:
{
Active: The metric is included in experiment analysis. ,
Inactive: The metric is excluded from experiment analysis but remains available for future use. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: A user-friendly display name for the experiment metric shown in reports and dashboards. ,
Required: True ,
}
string ,
description:
{
Description: A detailed description of the experiment metric. ,
Required: True ,
}
string ,
categories:
{
Description: Categories associated with the experiment metric. Used for organizing and filtering metrics. ,
Required: True ,
}
[
string ,
]
,
desiredDirection:
{
Description: The desired direction for changes in the metric value. ,
Enum:
{
Increase: An increase to the metric value is desired. E.g., Success rate, Total revenue. ,
Decrease: A decrease to the metric value is desired. E.g., Error rate, Latency. ,
Neutral: Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: The metric definition specifying how the metric value is calculated from event data. ,
Required: True ,
}
{
type:
{
Description: Discriminator property for ExperimentMetricDefinition. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: ETag of the experiment metric. ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The timestamp (UTC) of the last modification to the experiment metric resource. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetMetric (new)
Description :  Fetches an experiment metric by ID.
Reference :  Link ¶

⚼ Request

GET:  /experiment-metrics/{experimentMetricId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
experimentMetricId:
{
Description: Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if no entity matches this string. ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: The request should only proceed if the entity was not modified after this time. ,
Format: date-time ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: The request should only proceed if the entity was modified after this time. ,
Format: date-time ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The entity tag for the response. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Defines experiment metric metadata and computation details. ,
}
{
id:
{
Description: Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Determines whether it is included in experiment analysis. ,
Enum:
{
Active: The metric is included in experiment analysis. ,
Inactive: The metric is excluded from experiment analysis but remains available for future use. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: A user-friendly display name for the experiment metric shown in reports and dashboards. ,
Required: True ,
}
string ,
description:
{
Description: A detailed description of the experiment metric. ,
Required: True ,
}
string ,
categories:
{
Description: Categories associated with the experiment metric. Used for organizing and filtering metrics. ,
Required: True ,
}
[
string ,
]
,
desiredDirection:
{
Description: The desired direction for changes in the metric value. ,
Enum:
{
Increase: An increase to the metric value is desired. E.g., Success rate, Total revenue. ,
Decrease: A decrease to the metric value is desired. E.g., Error rate, Latency. ,
Neutral: Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: The metric definition specifying how the metric value is calculated from event data. ,
Required: True ,
}
{
type:
{
Description: Discriminator property for ExperimentMetricDefinition. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: ETag of the experiment metric. ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The timestamp (UTC) of the last modification to the experiment metric resource. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateOrUpdateMetric (new)
Description :  Creates or updates an experiment metric.
Reference :  Link ¶

⚼ Request

PATCH:  /experiment-metrics/{experimentMetricId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
experimentMetricId:
{
Description: Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if no entity matches this string. ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: The request should only proceed if the entity was not modified after this time. ,
Format: date-time ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: The request should only proceed if the entity was modified after this time. ,
Format: date-time ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
lifecycle:
{
Description: Determines whether it is included in experiment analysis. ,
Enum:
{
Active: The metric is included in experiment analysis. ,
Inactive: The metric is excluded from experiment analysis but remains available for future use. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly display name for the experiment metric shown in reports and dashboards. ,
Required: False ,
}
string ,
description:
{
Description: A detailed description of the experiment metric. ,
Required: False ,
}
string ,
categories:
{
Description: Categories associated with the experiment metric. Used for organizing and filtering metrics. ,
Required: False ,
}
[
string ,
]
,
desiredDirection:
{
Description: The desired direction for changes in the metric value. ,
Enum:
{
Increase: An increase to the metric value is desired. E.g., Success rate, Total revenue. ,
Decrease: A decrease to the metric value is desired. E.g., Error rate, Latency. ,
Neutral: Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks ,
}
,
Required: False ,
}
enum ,
definition:
{
Description: The metric definition specifying how the metric value is calculated from event data. ,
Required: False ,
}
{
type:
{
Description: Discriminator property for ExperimentMetricDefinition. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The entity tag for the response. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Defines experiment metric metadata and computation details. ,
}
{
id:
{
Description: Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Determines whether it is included in experiment analysis. ,
Enum:
{
Active: The metric is included in experiment analysis. ,
Inactive: The metric is excluded from experiment analysis but remains available for future use. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: A user-friendly display name for the experiment metric shown in reports and dashboards. ,
Required: True ,
}
string ,
description:
{
Description: A detailed description of the experiment metric. ,
Required: True ,
}
string ,
categories:
{
Description: Categories associated with the experiment metric. Used for organizing and filtering metrics. ,
Required: True ,
}
[
string ,
]
,
desiredDirection:
{
Description: The desired direction for changes in the metric value. ,
Enum:
{
Increase: An increase to the metric value is desired. E.g., Success rate, Total revenue. ,
Decrease: A decrease to the metric value is desired. E.g., Error rate, Latency. ,
Neutral: Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: The metric definition specifying how the metric value is calculated from event data. ,
Required: True ,
}
{
type:
{
Description: Discriminator property for ExperimentMetricDefinition. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: ETag of the experiment metric. ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The timestamp (UTC) of the last modification to the experiment metric resource. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: The entity tag for the response. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Defines experiment metric metadata and computation details. ,
}
{
id:
{
Description: Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Determines whether it is included in experiment analysis. ,
Enum:
{
Active: The metric is included in experiment analysis. ,
Inactive: The metric is excluded from experiment analysis but remains available for future use. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: A user-friendly display name for the experiment metric shown in reports and dashboards. ,
Required: True ,
}
string ,
description:
{
Description: A detailed description of the experiment metric. ,
Required: True ,
}
string ,
categories:
{
Description: Categories associated with the experiment metric. Used for organizing and filtering metrics. ,
Required: True ,
}
[
string ,
]
,
desiredDirection:
{
Description: The desired direction for changes in the metric value. ,
Enum:
{
Increase: An increase to the metric value is desired. E.g., Success rate, Total revenue. ,
Decrease: A decrease to the metric value is desired. E.g., Error rate, Latency. ,
Neutral: Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: The metric definition specifying how the metric value is calculated from event data. ,
Required: True ,
}
{
type:
{
Description: Discriminator property for ExperimentMetricDefinition. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: ETag of the experiment metric. ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The timestamp (UTC) of the last modification to the experiment metric resource. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteMetric (new)
Description :  Deletes an experiment metric.
Reference :  Link ¶

⚼ Request

DELETE:  /experiment-metrics/{experimentMetricId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
experimentMetricId:
{
Description: Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. ,
Required: True ,
}
string ,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if no entity matches this string. ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: The request should only proceed if the entity was not modified after this time. ,
Format: date-time ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: The request should only proceed if the entity was modified after this time. ,
Format: date-time ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ValidateMetric (new)
Description :  Validates an experiment metric definition.
Reference :  Link ¶

⚼ Request

POST:  /experiment-metrics:validate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Description: Experiment metric input to validate ,
Required: True ,
}
{
id:
{
Description: Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Determines whether it is included in experiment analysis. ,
Enum:
{
Active: The metric is included in experiment analysis. ,
Inactive: The metric is excluded from experiment analysis but remains available for future use. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: A user-friendly display name for the experiment metric shown in reports and dashboards. ,
Required: True ,
}
string ,
description:
{
Description: A detailed description of the experiment metric. ,
Required: True ,
}
string ,
categories:
{
Description: Categories associated with the experiment metric. Used for organizing and filtering metrics. ,
Required: True ,
}
[
string ,
]
,
desiredDirection:
{
Description: The desired direction for changes in the metric value. ,
Enum:
{
Increase: An increase to the metric value is desired. E.g., Success rate, Total revenue. ,
Decrease: A decrease to the metric value is desired. E.g., Error rate, Latency. ,
Neutral: Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: The metric definition specifying how the metric value is calculated from event data. ,
Required: True ,
}
{
type:
{
Description: Discriminator property for ExperimentMetricDefinition. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: ETag of the experiment metric. ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The timestamp (UTC) of the last modification to the experiment metric resource. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: The result of validating an experiment metric. ,
}
{
isValid:
{
Description: Indicates whether the experiment metric is valid. ,
Required: True ,
}
boolean ,
diagnostics:
{
Description: Diagnostic details from the validation process. ,
Required: True ,
}
[
{
message:
{
Description: A human-readable error message. ,
Required: True ,
}
string ,
code:
{
Description: The diagnostic error code. ,
Enum:
{
FailedSchemaValidation: The metric definition does not conform to the required schema. ,
InvalidEventCondition: The filter condition is invalid. ,
UnsupportedEventCondition: The filter condition is valid but not currently supported. ,
InvalidExperimentMetricDefinition: The provided metric definition is invalid. For example, defining a metric to calculate the average of a numeric property but including a filter condition that compares it to a string value creates a type mismatch. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}