Adding Online Experimentation data plane API.

specification/onlineexperimentation/Azure.Analytics.OnlineExperimentation/client.tsp

@@ -0,0 +1,10 @@
+import "@azure-tools/typespec-client-generator-core";
+import "./main.tsp";
+
+using Azure.ClientGenerator.Core;
+
+// @typespec/http-client-csharp: Convenience method is not supported for PATCH method.
+@@convenientAPI(Azure.Analytics.OnlineExperimentation.createOrUpdateMetric,
+  false,
+  "csharp"
+);

specification/onlineexperimentation/Azure.Analytics.OnlineExperimentation/examples/2025-05-31-preview/CreateOrUpdateMetric_Average.json

@@ -0,0 +1,84 @@
+{
+  "title": "CreateOrUpdateMetric_Average",
+  "operationId": "CreateOrUpdateMetric",
+  "parameters": {
+    "experimentMetricId": "avg_purchase_revenue",
+    "api-version": "2025-05-31-preview",
+    "If-Match": "vxexdn",
+    "If-None-Match": "ijchzdh",
+    "If-Unmodified-Since": "Thu, 22 Aug 2024 02:02:11 GMT",
+    "If-Modified-Since": "Thu, 22 Aug 2024 02:02:11 GMT",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+    "resource": {
+      "displayName": "Average revenue per purchase [USD]",
+      "description": "The average revenue per purchase transaction in USD. Refund transactions are excluded from this metric. The total revenue might increase while this metric decreases if the number of purchases increases.",
+      "lifecycle": "Active",
+      "categories": [
+        "Monetization"
+      ],
+      "desiredDirection": "Increase",
+      "definition": {
+        "type": "Average",
+        "value": {
+          "eventName": "Transaction",
+          "eventProperty": "Revenue",
+          "filter": "Revenue > 0"
+        }
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "ETag": "ETag",
+        "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "id": "avg_purchase_revenue",
+        "displayName": "Average revenue per purchase [USD]",
+        "description": "The average revenue per purchase transaction in USD. Refund transactions are excluded from this metric. The total revenue might increase while this metric decreases if the number of purchases increases.",
+        "lifecycle": "Active",
+        "categories": [
+          "Monetization"
+        ],
+        "desiredDirection": "Increase",
+        "definition": {
+          "type": "Average",
+          "value": {
+            "eventName": "Transaction",
+            "eventProperty": "Revenue",
+            "filter": "Revenue > 0"
+          }
+        },
+        "eTag": "ckswkavwgassdlocwuzxz",
+        "lastModifiedAt": "2024-08-28T20:27:13.652Z"
+      }
+    },
+    "201": {
+      "headers": {
+        "ETag": "ETag",
+        "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "id": "avg_purchase_revenue",
+        "displayName": "Average revenue per purchase [USD]",
+        "description": "The average revenue per purchase transaction in USD. Refund transactions are excluded from this metric. The total revenue might increase while this metric decreases if the number of purchases increases.",
+        "lifecycle": "Active",
+        "categories": [
+          "Monetization"
+        ],
+        "desiredDirection": "Increase",
+        "definition": {
+          "type": "Average",
+          "value": {
+            "eventName": "Transaction",
+            "eventProperty": "Revenue",
+            "filter": "Revenue > 0"
+          }
+        },
+        "eTag": "ckswkavwgassdlocwuzxz",
+        "lastModifiedAt": "2024-08-28T20:27:13.652Z"
+      }
+    }
+  }
+}

specification/onlineexperimentation/Azure.Analytics.OnlineExperimentation/examples/2025-05-31-preview/CreateOrUpdateMetric_EventCount.json

@@ -0,0 +1,81 @@
+{
+  "title": "CreateOrUpdateMetric_EventCount",
+  "operationId": "CreateOrUpdateMetric",
+  "parameters": {
+    "experimentMetricId": "events_purchase_creditcard",
+    "api-version": "2025-05-31-preview",
+    "If-Match": "vxexdn",
+    "If-None-Match": "ijchzdh",
+    "If-Unmodified-Since": "Thu, 22 Aug 2024 02:02:11 GMT",
+    "If-Modified-Since": "Thu, 22 Aug 2024 02:02:11 GMT",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+    "resource": {
+      "displayName": "Number of purchases (credit card)",
+      "description": "The number of purchase transactions made with credit card. Refund transactions are excluded from this metric.",
+      "lifecycle": "Active",
+      "categories": [
+        "Monetization"
+      ],
+      "desiredDirection": "Increase",
+      "definition": {
+        "type": "EventCount",
+        "event": {
+          "eventName": "Transaction",
+          "filter": "Revenue > 0 and ['payment.method'] == 'credit_card'"
+        }
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "ETag": "ETag",
+        "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "id": "events_purchase_creditcard",
+        "displayName": "Number of purchases (credit card)",
+        "description": "The number of purchase transactions made with credit card. Refund transactions are excluded from this metric.",
+        "lifecycle": "Active",
+        "categories": [
+          "Monetization"
+        ],
+        "desiredDirection": "Increase",
+        "definition": {
+          "type": "EventCount",
+          "event": {
+            "eventName": "Transaction",
+            "filter": "Revenue > 0 and ['payment.method'] == 'credit_card'"
+          }
+        },
+        "eTag": "ckswkavwgassdlocwuzxz",
+        "lastModifiedAt": "2024-08-28T20:27:13.652Z"
+      }
+    },
+    "201": {
+      "headers": {
+        "ETag": "ETag",
+        "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "id": "events_purchase_creditcard",
+        "displayName": "Number of purchases (credit card)",
+        "description": "The number of purchase transactions made with credit card. Refund transactions are excluded from this metric.",
+        "lifecycle": "Active",
+        "categories": [
+          "Monetization"
+        ],
+        "desiredDirection": "Increase",
+        "definition": {
+          "type": "EventCount",
+          "event": {
+            "eventName": "Transaction",
+            "filter": "Revenue > 0 and ['payment.method'] == 'credit_card'"
+          }
+        },
+        "eTag": "ckswkavwgassdlocwuzxz",
+        "lastModifiedAt": "2024-08-28T20:27:13.652Z"
+      }
+    }
+  }
+}

specification/onlineexperimentation/Azure.Analytics.OnlineExperimentation/examples/2025-05-31-preview/CreateOrUpdateMetric_EventRate.json

@@ -0,0 +1,81 @@
+{
+  "title": "CreateOrUpdateMetric_EventRate",
+  "operationId": "CreateOrUpdateMetric",
+  "parameters": {
+    "experimentMetricId": "rate_refund",
+    "api-version": "2025-05-31-preview",
+    "If-Match": "vxexdn",
+    "If-None-Match": "ijchzdh",
+    "If-Unmodified-Since": "Thu, 22 Aug 2024 02:02:11 GMT",
+    "If-Modified-Since": "Thu, 22 Aug 2024 02:02:11 GMT",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+    "resource": {
+      "displayName": "Refund rate",
+      "description": "The percentage of transactions that are refunds. This metric is calculated as the number of refund transactions divided by the total number of transactions.",
+      "lifecycle": "Active",
+      "categories": [
+        "Monetization"
+      ],
+      "desiredDirection": "Neutral",
+      "definition": {
+        "type": "EventRate",
+        "event": {
+          "eventName": "Transaction"
+        },
+        "rateCondition": "Revenue < 0"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "ETag": "ETag",
+        "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "id": "rate_refund",
+        "displayName": "Refund rate",
+        "description": "The percentage of transactions that are refunds. This metric is calculated as the number of refund transactions divided by the total number of transactions.",
+        "lifecycle": "Active",
+        "categories": [
+          "Monetization"
+        ],
+        "desiredDirection": "Neutral",
+        "definition": {
+          "type": "EventRate",
+          "event": {
+            "eventName": "Transaction"
+          },
+          "rateCondition": "Revenue < 0"
+        },
+        "eTag": "ckswkavwgassdlocwuzxz",
+        "lastModifiedAt": "2024-08-28T20:27:13.652Z"
+      }
+    },
+    "201": {
+      "headers": {
+        "ETag": "ETag",
+        "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "id": "rate_refund",
+        "displayName": "Refund rate",
+        "description": "The percentage of transactions that are refunds. This metric is calculated as the number of refund transactions divided by the total number of transactions.",
+        "lifecycle": "Active",
+        "categories": [
+          "Monetization"
+        ],
+        "desiredDirection": "Neutral",
+        "definition": {
+          "type": "EventRate",
+          "event": {
+            "eventName": "Transaction"
+          },
+          "rateCondition": "Revenue < 0"
+        },
+        "eTag": "ckswkavwgassdlocwuzxz",
+        "lastModifiedAt": "2024-08-28T20:27:13.652Z"
+      }
+    }
+  }
+}

specification/onlineexperimentation/Azure.Analytics.OnlineExperimentation/examples/2025-05-31-preview/CreateOrUpdateMetric_Percentile.json

@@ -0,0 +1,87 @@
+{
+  "title": "CreateOrUpdateMetric_Percentile",
+  "operationId": "CreateOrUpdateMetric",
+  "parameters": {
+    "experimentMetricId": "p95_page_load_time",
+    "api-version": "2025-05-31-preview",
+    "If-Match": "vxexdn",
+    "If-None-Match": "ijchzdh",
+    "If-Unmodified-Since": "Thu, 22 Aug 2024 02:02:11 GMT",
+    "If-Modified-Since": "Thu, 22 Aug 2024 02:02:11 GMT",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+    "resource": {
+      "displayName": "95th percentile of page load time [ms]",
+      "description": "The 95th percentile of the page load time for all pages. Measured in milliseconds. Review page-specific metric results to identify pages that need optimization.",
+      "lifecycle": "Active",
+      "categories": [
+        "Performance",
+        "Important"
+      ],
+      "desiredDirection": "Decrease",
+      "definition": {
+        "type": "Percentile",
+        "value": {
+          "eventName": "PageLoad",
+          "eventProperty": "LoadTime_ms"
+        },
+        "percentile": 95
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "ETag": "ETag",
+        "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "id": "p95_page_load_time",
+        "displayName": "95th percentile of page load time [ms]",
+        "description": "The 95th percentile of the page load time for all pages. Measured in milliseconds. Review page-specific metric results to identify pages that need optimization.",
+        "lifecycle": "Active",
+        "categories": [
+          "Performance",
+          "Important"
+        ],
+        "desiredDirection": "Decrease",
+        "definition": {
+          "type": "Percentile",
+          "value": {
+            "eventName": "PageLoad",
+            "eventProperty": "LoadTime_ms"
+          },
+          "percentile": 95
+        },
+        "eTag": "ckswkavwgassdlocwuzxz",
+        "lastModifiedAt": "2024-08-28T20:27:13.652Z"
+      }
+    },
+    "201": {
+      "headers": {
+        "ETag": "ETag",
+        "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "id": "p95_page_load_time",
+        "displayName": "95th percentile of page load time [ms]",
+        "description": "The 95th percentile of the page load time for all pages. Measured in milliseconds. Review page-specific metric results to identify pages that need optimization.",
+        "lifecycle": "Active",
+        "categories": [
+          "Performance",
+          "Important"
+        ],
+        "desiredDirection": "Decrease",
+        "definition": {
+          "type": "Percentile",
+          "value": {
+            "eventName": "PageLoad",
+            "eventProperty": "LoadTime_ms"
+          },
+          "percentile": 95
+        },
+        "eTag": "ckswkavwgassdlocwuzxz",
+        "lastModifiedAt": "2024-08-28T20:27:13.652Z"
+      }
+    }
+  }
+}