diff --git a/.gitignore b/.gitignore index 28d73cf0..d28e7935 100644 --- a/.gitignore +++ b/.gitignore @@ -7,10 +7,17 @@ # Generated files .docusaurus .cache-loader -/docs/APIs-and-SDKs/SDK-API*.mdx -/docs/Web-Console-API/*.mdx -/docs/APIs-and-SDKs/SDK-API*.js -/docs/Web-Console-API/*.js + +# Generated OpenAPI docs (run `yarn gen:api` to regenerate). Everything in these +# directories is plugin output except _category_.json and the hand-authored +# Examples/ page, so ignore everything and carve those back out rather than +# listing every generated filename pattern (which drifts each time the plugin +# changes its output, e.g. the *.ParamsDetails.json/etc sidecars added in 5.x). +/docs/APIs-and-SDKs/SDK-API/* +!/docs/APIs-and-SDKs/SDK-API/_category_.json +/docs/APIs-and-SDKs/Web-Console-API/* +!/docs/APIs-and-SDKs/Web-Console-API/_category_.json +!/docs/APIs-and-SDKs/Web-Console-API/Examples # Worktrees /.worktrees diff --git a/docs/APIs-and-SDKs/SDK-API/absmartly-collector-api.info.mdx b/docs/APIs-and-SDKs/SDK-API/absmartly-collector-api.info.mdx deleted file mode 100644 index 8fdcf195..00000000 --- a/docs/APIs-and-SDKs/SDK-API/absmartly-collector-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: absmartly-collector-api -title: "ABsmartly Collector API" -description: "An OpenAPI Specification that describes the ABsmartly Collector API. This API is mainly used when using ABsmartly in a language that does not yet have a supported SDK." -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; - -Version: 1.0.0 - -

ABsmartly Collector API

- - - -An OpenAPI Specification that describes the ABsmartly Collector API. This API is mainly used when using ABsmartly in a language that does not yet have a supported SDK. - -

Authentication

Security Scheme Type:apiKey
Header parameter name:X-API-Key

Contact

API Support: api@absmartly.com

License

- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/SDK-API/collector-health-check.api.mdx b/docs/APIs-and-SDKs/SDK-API/collector-health-check.api.mdx deleted file mode 100644 index cae4d66d..00000000 --- a/docs/APIs-and-SDKs/SDK-API/collector-health-check.api.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: collector-health-check -title: "Check Service Health" -description: "A GET request to check that the service is running as expected." -sidebar_label: "Check Service Health" -hide_title: true -hide_table_of_contents: true -api: eJytU02L2zAQ/SvDnL1OttCLT3W3yzbsoYGkUAg5TOTZSNSWFGmcxhj/9yLbIWlLe+rJ8ui9+Xjz1KPQMWKxQ+XqmpW4gPsMK44qGC/GWSywhJfnLQQ+tRwFxIHSrL6DaBIQzRA5nI1iMBFCa62xR6AIfPGshKscM3SeA6VsqwqLW6nPTLXop5QNMwwcvbORIxY9vlsu0+fXRjYczhxSHT0yOxwyfP9vpHVyQw8ZNizapS6OLJihJ9FY4OIKyTCO1KRJj22osUAt4mOxWESy1cFdcjrEhoLUXW7c4vyIwz6xVBuMdCOt9OaV03F/f7VRmptpuiugR+k8Y4E0BTK01KT/bw/levUwhUwaSDNVHEaVTq0JXGEhoeU0kbFvbkxlpE7c8uPcHjxdhYZyvcIM01yTPo/5Ml/iH4u28MWzLdcr2HhW5s2ocWvTqifsgeO49L9UyWGrTUynJH5DxtYdtJEr+KHZQhuTO25cY4GgJnts6chzGcfT1joW0HRmIIit9y4IV7D59JoMpZwVUpLGnhUbm55gmCE3ZOpJ1w+3dSnXJMfURrGNfEdeB+eDYaEwmcS7KA3ZO8RoUtjMTp+M+7t+/dgWW/kvb2Z2hvBFFr4mY1ProyH72bU7vLp2n6F2UVKo7w8U+WuohyGFTy2H0YkZnikYOiSL7Pb3D+HleYvD8BN8TGJM -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Check Service Health

- - - - - -A GET request to check that the service is running as expected. - -
- -Server is healthy - -
- -Server is not healthy - -
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/SDK-API/context-create.api.mdx b/docs/APIs-and-SDKs/SDK-API/context-create.api.mdx deleted file mode 100644 index 2faace6e..00000000 --- a/docs/APIs-and-SDKs/SDK-API/context-create.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: context-create -title: "Create a Context" -description: "A POST request for creating a new context and assigning variants to your users." -sidebar_label: "Create a Context" -hide_title: true -hide_table_of_contents: true -api: eJztWF9v2zYQ/yoEnzZAie3YcxI9zU37kHXDgibpBsRBe5JOEluJVEnKsWf4uw9HypbcuF7mpigGLA+JQt4df/f/yCW3kBke3vFYSYtzy+8DnqCJtaisUJKHfMKufr++YRo/1WgsS5VmsUawQmYMmMQH1rAykAkDY0QmaW8GWoC0hlnFFqrWrDaozTEPuKpQA0m/THi4PviCZCIPeAUaSrSoCdaSSyiRh/zPo0mG0vKACwKVIySoecAJltCY8NDqGj/HfpMjuzWoPTNTqUdy/fI14cA5lFVB0iEyJWhbLI5+gRkcXb98zWaD4/7xgAfcxDmWwMMlt4uKiI3VQmZ8tQo66F7JmdBKlodhxJabCckechHnBJWBRqZr6QzqoOO8Qi2I0ByzmxwNshgki5Clqib7y8S7BxOS5HgmLxrt2B8YsQsljSqQGbTkQ7NtiQRnWKiq0eNpuk+qqhCx8+gBukPL/Z11f3h4OETno7eozdfrPvNSnmgApuQW+P4O4EJazBySVOkSrF8aj/hqde/RobEvVLIgnv1gb6WwhiVgwRUAj9GqxtzM5rhVBZrcb6pB4zGSwQia+Wq3TeVUvn///oNRciqXU8nY1Ck95SGbcio070Qy5azXozhh5DVKfoJZr1F4rproiGkEo5PT8TiG8XAwTE7G6ej8/OwnPD0/T9NROjw976fR2RhT6KcxjsaYREOEszRKBwjDUf+sPW0GRf3ZcTnYjUethvijkNnxVK6cFlOKHGc9ackTnaDokYa09si3KvqAsd0KsjtOhxmq4JWmGmsFGmLxyy0vaA0LilaLpfknmW7vkUjP8XmKdJOpcQJfBWTjXbSlkL+izGzOw0HAS5iv/xuP+l1JX+sZylxuhXXCKAj5qrty4eP2jU8H2luRBUylpPHKnvT79Gc7I67rOEZjntd1Ae9kzP+OfIIjty12oGlE4in1uoe5Mh/wpoyROQqRiahA7+5UZI8tuWWb3aV3eOKtJcq6dCV7Y5vhqgvgcDknqwb8XpfivHoXgZSo38WqUJp8u9b1X59dwtx/D05OO4cMVh2rtUIjpQoE2YVD/Yb8WCcCZYy/CVOCjfP9TCkUhriUFpmQULz9BvAbT+8wpayLAqIN+E5Yvtq06MkmLr9Qb3yFaQrOaFeNeQHJeu5+rjoTq4SCuERjINtRD9z+U0aIVsauSam1h9YUX42Og8c63kqoba60+AtdjUkwhbqwuwhp/IlpSkAn9D9vEcdhc0W3oEo5H1dAdZP31rexgBvUs/VdqNYFzZfWVibs9QzIJFLz483l5Vio3mzAabgzGNda2IVjm1TiNdLnfXfrmqzjVVwTtNXTLwSdeffq8sgv7ZtxSSWy/pt2tny1zqhN+7rbHLNuLU1neYYGcU91VKbK6dIYvJ0lL1RRYGyVZpOrS6rvzeAecrrs9fmjq69kv1coJ1eX7LrCWKTrWd0NdJ42QuMGvS+cQhcVYeiLCcNKELJY0E04YQ85SlYbGu5bXiEZsAJkVkOGzTEKDZPKsgValsMMGTBTV5XSlArNVZbiBWKXCY3LHGhPRnWzBFF4x/7cxkusSgrbQsRIlahlvtKq0gIt6IWLXYrOEmSHwl/XGbCLTaRu2W7ZJuc3eEFo4od4elUBQrrphLJj2aTQ1oNGTskV3vHlMgKDt7pYrWj5U43apUXT/VxBv6MQasKbQjURhjaSpuXsUfOHN00u/Mj2vzvsRP+RErDzzOFuETzknK6dB4P43g8Le1XdfjN5HoW/92vCft9uPZQ8v8IHPSE8FXHnmWMLuSe98PiObkhaS/GoLbcckzjGyu6lve80SCohPOBR81xRuq7MNdCTDf0O+ZRPuXtdJAmur7n1JV/XUx5yL5d+/gYMTisZ -sidebar_class_name: "post api-method" -info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Create a Context

- - - - - -A POST request for creating a new context and assigning variants to your users. - -## Request - -

Header Parameters

Body

required
- -Units data for which to create the context and variant assignments. Unit types can be found and created in your ABsmartly Web Console settings. - -```json -{ - "type": "user_id" // The name of the unit type - "uid": "4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408" // The value of the unit that you are tracking. -} -``` - - -
    units object[]required
  • Array [
  • ]
- -Success - -
Schema
    units object[]required
  • Array [
  • ]
  • assignments object[]required
  • Array [
  • ]
- -Bad request - -
Schema
- -Unauthorized - -
- -Unexpected error - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/SDK-API/context-get.api.mdx b/docs/APIs-and-SDKs/SDK-API/context-get.api.mdx deleted file mode 100644 index 6a51bd09..00000000 --- a/docs/APIs-and-SDKs/SDK-API/context-get.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: context-get -title: "Get Context Experiment Data" -description: "A GET request for obtaining data on your experiments." -sidebar_label: "Get Context Experiment Data" -hide_title: true -hide_table_of_contents: true -api: eJzVV21v2zYQ/ivEfVYd243bRp/mviAI+qHBkm4D4qCgpLPNjiJV8ujEM/Tfh6NkS47dZC2KAAMMmCJ5L8/dw+NxAyQXHtIbyK0hvCe4TaBAnztVkbIGUpiK8w/XwuG3gJ7E3DphM5LKKLMQhSQprBFrG5zA+wqdKtGQH0ACtkInWcdFAelW/TkSJFBJJ0skdGx5A0aWCCmgWSlnDSuABBTb/hbQrSEBtq4cFpDOpfZ44KIRPWFBVsyVJnSCligc+qDJi2w9ENdL9ChyaUSGYm6DKYQ0hcgdSsJCqBbJ9K0vpSO9Fn9iJt5Z461G4ZFImUUEh/eyrDR7XeAKta1ar32+xFJCugFaV7zsySmzgLpOdjhlVWmVx9D8OM6e8PPivLu7exTfLXvvK2s8el4fD4f8tw/gKuQ5eg9JwwdDvKUH6eSr532bQzs2+4o57YXoBnqMY95WjjlHqnGgv9jpkc5JjrQiLP1T+lUBSZO1KOC2OQtG0TXLJQ9I6xFZxFda8Sc5OZ+r/KqZ3X61i/Og9Sfzh3RKRtleGDhAq2aBhzIUCk2OveEVOZXTIWhV9DApQ7hA10/jaPyybiEd5LCfbbyvvmTSGHRfcqutg7ofgUdNDOtegB41Ejy6L6pg3f0wPipTOVuEPHpRt/E+5s3culJSM/XqtK/h7HTy8tXr09Hrs8n4Tb3N1dMEMaHM9lUXNmQao/db5TfDwSQZDia39X7yf8zFF5NX49PR5Gz05s3Z2XBSP6DOL/M1GbGf+zx8ytOXY0igVEaVoYR0mEAp75vxaPy6T7T6AaN/8ghGqh7Q/GkC32HmFSEXXiBFce7DriJMeyWYd+wO2zN7SVyQI+nrWBLnanFMwAStJecvJRewr2Azg3g+Z5DOwGExg/o7kLcJ5tVdQXnUuY2YQXO/zCAVN/y5oN1wJeP0DOQCZyDqRDSzOiDPj4eivo0/qA/KVmc2s1ajNH278ebrY3jXtA4dFKiPLJ8j/d7eP7xeJ3B67AZ6K4ttL/OrbqHcFlyaS/ReLo7QIK7/hwpQdzqO9Q9dTp3jgtxiHB1i/GxkoKV16h+MxbXAuQyajm3kSzLnlgCj0v99RKIELS23nIu216QlpHCy7W/50nCrbesZnIYUlkSVT09OvDRFZu8HMmv7ooGyJ6sRcHPjMQ9O0TqKTSv1EXl421+64uA0CLcbunLSTGzvXvjrxfTy4kUzFVvAJcoixqALJB92RqTM3EZVLdyubXtntcacrBPTywtuGtD5JrWjwXAwhCMN5KcKzfTyQlxVmKv5rpVcShLN3gx97Ce/Y4WbS+V5JJQXpVRGr0XwWIi7JRoRPL8LOlllhBRamkWQC2zNWPTCWBJrJLGUKxRS+FBV1jERr95/HLQ8lE2paCMWnW62cbkopdJNXH/r0pXbkkmjVY5cBzrhS2crp5CkW0fmVNZTKU1vxzmSaEuJ6EqNeC9JPgzjpjslP/06amnB5k4qLVVsZyIbNy1l955kS+uJpzabTHr87HRd83TzbmBGFsrzDfGdl8Oex8/+WDqK9W8+Hg/a53h7QArAr6UfQvTMz6JHEO2/7jpEt22XEa/xG2682hPP2WtEp3mOVT8OBxWYtezq2/mHa6jrfwH7Smgm -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Get Context Experiment Data

- - - - - -A GET request for obtaining data on your experiments. - -## Request - -

Query Parameters

- -Success - -
Schema
    experiments object[]required
  • Array [
  • applications object[]required
  • Array [
  • ]
  • variants object[]required
  • Array [
  • ]
  • ]
- -Bad request - -
Schema
- -Unauthorized - -
- -Unexpected error - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/SDK-API/context-publish-batch.api.mdx b/docs/APIs-and-SDKs/SDK-API/context-publish-batch.api.mdx deleted file mode 100644 index b10bc371..00000000 --- a/docs/APIs-and-SDKs/SDK-API/context-publish-batch.api.mdx +++ /dev/null @@ -1,134 +0,0 @@ ---- -id: context-publish-batch -title: "Publish Experiment Events for Multiple Contexts" -description: "A PUT request for publishing your exposures, goals and attributes from multiple contexts." -sidebar_label: "Publish Experiment Events for Multiple Contexts" -hide_title: true -hide_table_of_contents: true -api: eJztWtty2zgS/RUUXnY3RdvyJY6tp1UyrhlvNjWuxN7ZKsuVgGSTxJgEOAAoWetS1fzG/N58yVbjwoskazROtrIPyYMjkuhG9+kLugE8UsNyTce3NJHCwIOhEY2ZSQp6F9EUdKJ4bbgUdEwn5Ormmij4pQFtSCYVqZu45LrgIicL2SgCD7XUjQIdkVyyUhMmUsKMUTxuDGiSKVmRqikNr0sgfkK9TyMqa1AM57lM6TiIcuXYv7biRLRmilVgQKG4j1SwCuiY/ntvkoNAsTkKWQBLQdGIopxcQUrHRjWwqst1AeRGg3LERGZOgQ/fvUVp4IFVdYncWawrpky52PsHm7G9D9+9JbPD/dH+IY2oTgqoGB0/UrOocbA2ioucLpdRT7oLMeNKiup5MkJHTbgg84InBYpKmAKiGiH62IPiOFDvk+sCNJCECRIDyWSDZhApSRQwAylysjST11478hPE5I0UWpZANBjDRa6HSKQwg1LWXo/ddJ/UdckTa9dn6M466q+s+3w+f47Oe/8CpT9f95njsiMARIqB8KMNgnNhILeSZFJVzLhXpyd0ubxz0oE2r2W6QJrtwk4EYUqxBYZQygwjRoa0sD8VU/HixQ9MF5C+eIFPqFphn8mMlQ0QxywGTeYFmAKU08d+1KRgMyCsVMDSBYkBhCeOiFSEZ8QUsLBgGInG9pzjBX4gb2RZQmKkCnJwbaTiSU8S/8bLYqAs9ZC0lcoUXBOuiYA5zi3L1GrrWftEBSmZmI59Hd5OjJ+BO/aGV0CY8QbFNyGpzpkmFUvB870R3GjH0P50uhYQ8HEM8GWjIUUUkkJKHcYozoSZCqY1z4VzDszawJICCdQ+Qa4EnUJvC5ip2CViiNWZLUrJUmLYPThl0cOIzMaoxKdPn37WUkzF41QQMrXuOKVjMqUozkeeTik5OLCMMJ7Qp5BFE6R0VA2OQ6ITdnL06vQ0YafHh8fp0Wl2cn5+9hJenZ9n2Ul2/Op8lMVnp5CxUZbAySmk8TGwsyzODoEdn4zOutmceQbTFcy0sWYUS+65yPenYmm1cOa5CMudM1H7aD3JskpaR+LChRoGMotlE6zvrYRzM9GLY+sKupBzgWa1YmlQkbXMvACxEU8HzHEU1Lr8LuhkV2ZIexPsOxLE2aEJD/XHmAkB6mMiS6mmNNpkjCc5IWwrxmwZdJCiWt5Zcxdac26KwDkor8G5cw4C64KBQ/vpgnvTMTmMOjs6NNupLIKewks+cTSno/Ojk5PDV+cvj85a+vXIDCUNKVhdg4DUM3NBBRZwmxeRxU9ttnDmsiIEwLwZe1py4fKKriHhGU9CGogINySRTZliRFpdBhyFNCTMT2JIWKMBSVIJWvz+62+GVFgyWSLWpBxEAjZlrs6v2+SaNWX5o2gHBRxxNjkDpXgKIiJgkoBlyXMel/Ck+sNprKZAFM8LQ2qmTPAmo1iGmrOylH65szhx3edg05HLT0bxPAfV2sFLl4JAUTJW6nVZNmiTgkBdhQzu5AAY8rhWmLOzNXG49nhZwXCGOXeLcZiJaxIDvsikSpztYQZqIQX4+ZJGG1k9JTPXA6EZccNJl8qDG3rzvuPa2rxluJWfyyuyMZqnNrC5+f3X31pHRIGZysG03rOS+L7H4t4lve9dnd9bgmyytNPJRpMKjOKJdl5s6xYo7bJipF3qp6KXSIjj5k0dFiAE2S1LG2u3qVhdijbmxi7RhSRX8uT+iSSH3cuTS4DFPSk4zAbJ5OXGZNJGr2VpjelJPadaYe9jOGjk9LhE6olYkO59J8ic68IWWExj6EqRh+zJtZ1gxU6TtvVyxuqebcDNbTmgIUfwXfCFRsiWctJFbW+1/wNkWQ5PANo2gW32LhtLdHzejm/H/EW7BdmP1WA25OynU7ZbzK2fg+khQiPXWAqDZW2vwj5AdfDdWqEs458hMYOK/TbUxxo75M5KoVS2XzoOtjimEa24uDRQaTo+jGjFHvzDy9Eootz93j4rLqEau+CuqlwXwFXAPVaxlCUwVF00Zcli7AhCGZ+xpjR0bNPFMqKhGn4edV+sHRqNXoMysOoy8oquI7gTSvbbGiyOYrVv63d4vmShOD9PN42tuPgniNwUwYLh6fRk1Of0uUUptpPUcGOZYX1uX7Q7K38GmGGn9gOUpSRzqcp0BTSOL2wDG4WyikZduUSjttrB137lX0d5gNtmyx8fOSR51VS2NW1xO156EbaaabVGpd5fNlGtuuxGYwd1/7TgFXtwvw+PzvrOvOwD93mB0IK+KSBbKlRu2TPLLoO7Imj78BDcrtrZbayrVHYbu1q97ELVi47QcNkIsRuOz00b3vm7VX3du//YOft1BfpWj9szHOFl5wibklmnx9DP+/hgNTVxQthtO/zW7cZ+JlZ2VX4OTCwHF3llY0d2KeB8TZkwzecEUg+Qtv6hy/5rv33z3q3eG7/ZPejegCViomsptFP7aDTC/4YZ90OTJKD1l6o75P063PJ+Q8wsIzpnChuSZxvZHgFcihQeENgZCBMedBPGV6A1GnNNqB7xuuGWA34bv4cp1ndau0k37cKuG9RZ6J2nsQupUlJ9g2UIy9NjvK+fbHLv1ywNOxbfXPz/xpbfXPy5Ln647uI3gjWmkIr/B2y52LY96wNxGyPB7QoL/5cKiESmsA1w+32Xg50d8buwwi8dJBWYQuJ5bN0Ye/6K7Q498KezB7E/l9WgZuFQtlElHnQZU+vxwYFmIo3lw357irrP5cHskOIpk4akUdwsLNmk5m8Bf971P31AiJyeYUDn0+5F1Dt4u7rcc6+2HbahXmiC990h10WoG/oN/G3XTLsNul5/7F8MWt7hfnJoYm9beUPP4fvLL9Am3g26wlvXfx23gKy1SqFT6onSdj+Hg65lRZeuD/GNVNtquOd+N+GhCQ2Dfww9gX9cL/tdaX/XVvHd8f6gqB7W1MNdt2Fg2IPMfq3bccQYaMtPrDl9iTmsGu+Wd0v0pExapwsFZLvx2B0RTq4ukZ8/6h1TvB4wWuu+J4L8WIOYXF2SD36732934+ZedwyKG1hPzIInbFzjL9xfrhgX5cLtuuKBEGk0bjh3tFwQRkom8oblfh8SDwjs6cECjD9cJbqpa6kwcfnLDxjezOVgj5gV2g3DNaFivHQR+PcusBNZYZIpeQKYUzviKyVrxcEwtbCZppbaVEz0R7g4IhfdDvvFrD2tfBeui7zx10VWoX3sMu3/9IqKD2Sb+uqScVuE2Hz36FPjxjs0hdQGPz0+xkzDjSqXS3z9SwPKJjwfhTaebtHnfOJCj025xg9dDnpS8b++91nub2T71ZaNWtxjau3dpPHBQSnebHi2EF/77spWVYfXcr6Mwl/7wsp22w7u4nx5hZ91S2VXiXs3aQaSu6FvnHx718itG7FWdXUUkySB2mwde9erf65urjGk/YWYytZcVDG8FIR/x3RKp9TeYkMG7igA3z/SkH/pmDq2+O+/H3WWqg== -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Publish Experiment Events for Multiple Contexts

- - - - - -A PUT request for publishing your exposures, goals and attributes from multiple contexts. - -## Request - -

Header Parameters

Body

required
- -An array of data to publish. - -**Hashed** - -The hashed value describes whether your values have already been hashed, or if they are to be hashed by the Collector. - -**Historic** - -The historic value tells the Collector whether this is new or old data. - -**Published At** - -The publishedAt value is the time at which the request was made. - -**Units** - -Units are the values which are used to choose the variant -assignments for each user. Unit types can be found and created in -your ABsmartly Web Console settings. The payload takes the form of: - -```json -{ - "type": "user_id" // The name of the unit type - "uid": "4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408" // The value of the unit that you are tracking. -} -``` - -**Exposures** - -Exposures tell the collector information about which variant of an experiment was shown to the user, and when: - -```json -{ - "id": 3, // The ID of the exposed experiment. - "name": "exp_banner_color", // The name of the exposed experiment. - "unit": "user_id", // The unit that was used together with the experiment seed to generate the variant. - "variant": 1, // The variant that was shown. - "exposedAt": 1609244179528, // The time at which the exposure happened. - "assigned": true, // Whether the user was exposed to the experiment in this specific request, it could be that the user was not assigned because it doesn’t match the audience, or the experiment is already fullOn, or the variant was overriden, etc. - "eligible": true, // Whether the experiment is in the right part of the traffic allocation to this experiment and can be triggered. - "overridden": false, // Whether the variant was overridden or not. - "fullOn": false, // True if this experiment is fullOn and the winning variant is being forced to everyone. - "custom": false, // Whether this variant was a custom assignment. - "audienceMismatch": false // Whether this variant was shown outside of it’s specified target audience. -} -``` - -**Goals** - -Goals are used to track various metrics that are related to your -experiment. Goals can be created and found in your ABsmartly Web -Console settings: - -```json -{ - "name": "banner_click", // The name of the goal that you are tracking. - "achievedAt": 1609254179528, // The time that the goal was achieved. - "properties": {} // Any properties that you wish to pass along with this goal. -} -``` - -**Attributes** - -Attributes allow for segmentation of your data on the Web Console: - -```json -{ - "name": "age", // The name of the attribute. - "value": 39, // The attribute's value. - "setAt": 1609244179528 // The time at which the value was set. -} -``` - - -
    requests object[]required
    - -**Possible values:** `>= 1`, `<= 500` - -
  • Array [
  • units object[]required
  • Array [
  • ]
  • exposures object[]
  • Array [
  • ]
  • goals object[]
  • Array [
  • ]
  • attributes object[]
  • Array [
  • ]
  • ]
- -Success - -
Schema
    warnings object[]
  • Array [
  • ]
  • errors object[]
  • Array [
  • ]
- -Bad request - -
Schema
    warnings object[]
  • Array [
  • ]
  • errors object[]
  • Array [
  • ]
- -Unauthorized - -
- -Unexpected error - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/SDK-API/context-publish.api.mdx b/docs/APIs-and-SDKs/SDK-API/context-publish.api.mdx deleted file mode 100644 index b9135e25..00000000 --- a/docs/APIs-and-SDKs/SDK-API/context-publish.api.mdx +++ /dev/null @@ -1,130 +0,0 @@ ---- -id: context-publish -title: "Publish Experiment Events" -description: "A PUT request for publishing your exposures, goals and attributes." -sidebar_label: "Publish Experiment Events" -hide_title: true -hide_table_of_contents: true -api: eJztWm1v2zgS/isEv9xdobw4SdPEn87tBru57mKDNrk9oA5aShpJ3EiklqTs+AID+zf27+0vOQxf9GI7qdcN0PvQfkgtijOceeaFM6QeqGG5puMPNJHCwL2htxFNQSeK14ZLQcd0Qq5uromC3xrQhmRSkbqJS64LLnKykI0icF9L3SjQEcklKzVhIiXMGMXjxoDepxGVNSiGDC9TOg5rXTk+NKI1U6wCAwpFeaCCVUDH9D97kxyEoRHlKEgBLAVFI4qycAUpHRvVwKq81wWQGw3KEROZOSHff/cWBYF7VtUlcmexrpgy5WLvX2zG9t5/95bMRvuH+yMaUZ0UUDE6fqBmUeNkbRQXOV0uo550F2LGlRTVbjJCR024IPOCJwWKSpgCohoh+viC4jhR75PrAjSQhAkSA8lkg1CLlCQKmIEUOVmayWuvHfkFYvJGCi1LIBqM4SLXQyRSmEEpa6/HdrpP6rrkiTXpDrqzjvor6z6fz3fRee/foPSX6z5zXLYEgEgxEP5wg+BcGMitJJlUFTNu6PSELpe3TjrQ5rVMF0jzeWFTZhgxEvH2UQ/p/lRMxYsXPzB8ePECn3BqYZ/JjJUNEMcpBk3mBZgClFPGvtSkYDMgrFTA0gWJAYQnjohUhGfEFLCwSLiVPed4gS/IG1mWkBipghxcG6l40pPEj3hZDJSlHpK2UpmCa8I1ETDHtWWZWpU966ugMpmYjn0LxMT4Fbhjb3gFhBlvTRwJWXPONKlYCp7vjeBGO4b2p9O1gICPY4CDjYYUUUgKKXWYozgTZiqY1jwXzjMwLQNLCiRQ+wS5EvQI/VS0TMU24UKszmxRSpYSw+7AKYvuRWQ2RiU+ffr0q5ZiKh6mgpCp9cUpHZMpRXE+8nRKycGBZYTBhDkZWTRBSkfV4DwkOmEnR69OTxN2ejw6To9Os5Pz87OX8Or8PMtOsuNX54dZfHYKGTvMEjg5hTQ+BnaWxdkI2PHJ4Vm3mjPPYLmCmTbQjGLJHRf5/lQsrRbOPBdhP3Mmah+tJ1lWSetIXLg4wyhmsWyC9b2VcG0mekFsXUEXci7QrFYsDSqylpkXIDbi6YA5joJal98FnezWC2lvgX1Hgjg7NOG+/hgzIUB9TGQp1ZRGm4zxKCeEbcWYLYMOUlTLO2vuQmvOTRE4B+U1OHfOQWA9MHBov1xwbzomo6izo0OzXcoi6Cm85BNHc3p4fnRyMnp1/vLorKVfj8xQs5CC1TUIm9WQmQsqsIDbpIgsfmmzhTOXFSEA5s3Y05ILl1d0DQnPeBLSQES4IYlsyhQj0uoy4CikIWF9EkPCGg1IkkrQ4s/f/zCkYsbLz5qUg0jApszV9XWbXLOmLH8W7aSAI64mZ6AUT0FEBEwSsCx5zuMSHlV/uIzVFIjieWFIzZQJ3mQUy1BzVpbS73UWJ677HGw6cvnJKJ7noFo7eOlSEChKxkq9LssGbVIQqKuQwZ0cAEMe1wpzdrYmDtceLysYrjDnbicOK3FNYsCBTKrE2R5moBZSgF8vabSR1WMycz0QmhE3nXSpPLihN+9PXFubtwyf5OfyimyM5qkNbG7+/P2P1hFRYKZyMK33rCS+77F6d0nve1fI97YgmyztcrLRpAKjeKKdF9uiBUq7rRhpt/qp6CUS4rh5U4cNCEF229LGwm0qVreijbmxS3QhyZU8uXskyWF78ugWYHFPCg6zQTJ5uTGZtNFrWVpjelLPqVbY8xgOGjk9LJF6IhakG+8EmXNdIHA10xi6UuQhe3JtF1ix06TtrZyxumcbcHNbDmjIEXwXfKELsvWcdFHb2+0/gyzL4RFA2y6vzd5lY4mOz9v57Zy/abch+7kazIac/XjKdpu59XMwPURo5BpKYbCm7ZXXB6gOjq1VyTL+FRIzKNc/2I1OYzPa1XfYDXcGQwauFu2xiqUsgaEQoilLFmNhHqrpjDWloWMbuMuIhrp0N+q+WFvU+70+YYDvMvKKdjyYUmyBnYyBSn8OJftuDRZHsdo+9RstXzxQXJ+nm+ZWXPwIIjcFHY8iWrH78HR6ctjn9KXlIXZ11HBjmWGlbAfaQ4y/AsywYfoBylKSuVRlugIaxwHbR0ahwKFRV7jQqK07cNjvwesoD3DbbPnjI4ckr5rKdogtbsdLL8KTZlqtFqn3l01Uqy670dhB3b8seMXu3e/R0VnfmZd94L4sEFrQNwVkS4XKLXtm2WZyV448PT0Et6s7tpvraobt5q7WEdtQ9aIjtD42QuzZ3q5pwzt/t7+ue/fnnbO/w6Nv9bjt4AgvO0fYlMw6PYZ+3scH65qJE8KenuG77uDzC7Gy++MuMLEcXOSVjZ3ZpYDzNWXCMl8SSD1A2kqELvvD/iDlneuD8N0SVda1FNppdXR4iP8NE+r7JklA6+fa4OXdOprybkNILCM6Zwor/51tGGO0XYoU7hG3GQgTHnQT5legNdpqTage8bpdlgN+G9+HJdbPM7tFN511rtvLWegnT2P3SaWk+gbLEJbH53hfP9nk3q9ZGo4Gvrn4/40tv7n4ri4+WnfxG8EaU0jF/wu2Gmy7mvWJeF6Q4LmAhf+5AiKRKTwFuH2/zfXJlvhdWOGXDpIKTCHxwrNujL3lxG6GHoSrVtx71SxcejaqxIskY2o9PjjQTKSxvN9vbyn3uTyYjSje4mhIGsXNwpJNav4W8Odt/9V7BMdpGCZ03uwGot7F1tXlnht66jILNULw33WXSBehIOgaY3fs1et1/cCgfR2e0oaG9EMrYugffK/4DC3f7aDD++B6qeMWg7W2J3Q9PVHaTmY06EBWdOl6Ct8UtW2De+53Bh6aUPz7x1Df+8f1Et6V6bdtRd7dmA8K5GF9PDzLGkaBvRvs160dR3T4tpTE+tGXi8MK8HaJrpNJ62WhFGwP87prt8nVJXLzd6djivfth2t99ESQn2sQk6tL8t4fofsjZDww664W8VDokVXw1opr/IVnthXjoly4k0y8ZCGNxkPcjpYLwkjJRN6w3J/t4aG7PZFfgPEXlkQ3dS0V5ij/NQFGMnPp1uNlhXbTMP1XjJcu5P7ZRXIiK8wnJU8A02dHfKVkrTgYphY2qdRSm4qJ/gwXReSiO7W+wC1Br4L40KXP5/mCw0cmJq6DumTclhA2Zz34xDb4hqSQ2uDQw0PMNNyocrnE4d8aUDZZ+XCygfEB3ccnHXS9lGt80SWTRzX7+zufof5Bnv7sY6P0d5gWe1+ZeC+nFG/9dxbia3/X8aSqw09Wnkfhr/0xx9O2HXyn8vwK7/QFx7YS974yGUjupr5x8u1dI7duxlqt1FFMkgRq8+Tc217VcnVzTSMa+49FKlspUcXwgxn8O6ZTOqX24y5kYIsNO/5AQyqlY+rY4r//Ad/qOJw= -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Publish Experiment Events

- - - - - -A PUT request for publishing your exposures, goals and attributes. - -## Request - -

Header Parameters

Body

required
- -The data to be published. - -**Hashed** - -The hashed value describes whether your values have already been hashed, or if they are to be hashed by the Collector. - -**Historic** - -The historic value tells the Collector whether this is new or old data. - -**Published At** - -The publishedAt value is the time at which the request was made. - -**Units** - -Units are the values which are used to choose the variant -assignments for each user. Unit types can be found and created in -your ABsmartly Web Console settings. The payload takes the form of: - -```json -{ - "type": "user_id" // The name of the unit type - "uid": "4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408" // The value of the unit that you are tracking. -} -``` - -**Exposures** - -Exposures tell the collector information about which variant of an experiment was shown to the user, and when: - -```json -{ - "id": 3, // The ID of the exposed experiment. - "name": "exp_banner_color", // The name of the exposed experiment. - "unit": "user_id", // The unit that was used together with the experiment seed to generate the variant. - "variant": 1, // The variant that was shown. - "exposedAt": 1609244179528, // The time at which the exposure happened. - "assigned": true, // Whether the user was exposed to the experiment in this specific request, it could be that the user was not assigned because it doesn’t match the audience, or the experiment is already fullOn, or the variant was overriden, etc. - "eligible": true, // Whether the experiment is in the right part of the traffic allocation to this experiment and can be triggered. - "overridden": false, // Whether the variant was overridden or not. - "fullOn": false, // True if this experiment is fullOn and the winning variant is being forced to everyone. - "custom": false, // Whether this variant was a custom assignment. - "audienceMismatch": false // Whether this variant was shown outside of it’s specified target audience. -} -``` - -**Goals** - -Goals are used to track various metrics that are related to your -experiment. Goals can be created and found in your ABsmartly Web -Console settings: - -```json -{ - "name": "banner_click", // The name of the goal that you are tracking. - "achievedAt": 1609254179528, // The time that the goal was achieved. - "properties": {} // Any properties that you wish to pass along with this goal. -} -``` - -**Attributes** - -Attributes allow for segmentation of your data on the Web Console: - -```json -{ - "name": "age", // The name of the attribute. - "value": 39, // The attribute's value. - "setAt": 1609244179528 // The time at which the value was set. -} -``` - - -
    units object[]required
  • Array [
  • ]
  • exposures object[]
  • Array [
  • ]
  • goals object[]
  • Array [
  • ]
  • attributes object[]
  • Array [
  • ]
- -Success - -
Schema
    warnings object[]
  • Array [
  • ]
  • errors object[]
  • Array [
  • ]
- -Bad request - -
Schema
    warnings object[]
  • Array [
  • ]
  • errors object[]
  • Array [
  • ]
- -Unauthorized - -
- -Unexpected error - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/SDK-API/experiment-get.api.mdx b/docs/APIs-and-SDKs/SDK-API/experiment-get.api.mdx deleted file mode 100644 index e9a9b38a..00000000 --- a/docs/APIs-and-SDKs/SDK-API/experiment-get.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: experiment-get -title: "Get Experiment Data" -description: "A GET request for obtaining data on all running experiments." -sidebar_label: "Get Experiment Data" -hide_title: true -hide_table_of_contents: true -api: eJzFVktv20YQ/iuDObUArUea9MBT1dgwXB9qRHZawDaCETkSN1nuMrtL2arA/14MSYuUpdiGYsAnUbvz+Gb2m8caAy08xtfI9wU7lbMJeBuhLdhRUNacpRj37k45YIQp+8SpQu4xxgmcnlyC4+8l+wBz68DOAimjzAJSCgTWAGkNrjT1WWfNDzDCghzlHNgJjDUayhlj/PdoshAsESrxkTGl7DBCcaMcpxgHV/JjKJcZw5Vn1yiDncPKlg6mx+fiie8pL7RYp5nPyQW9OvqLlnQ0PT6H5XgwGowxQp9knBPGawyrQoR9cMossKqiHroTs1TOmvwwjNxpgzJwl6kkE6hAjjd5qqH3kwWXGXuGhAzMGOa2NCmQSSFxTIFTsVTrTP5so4N/eAYfrfFWM3gOQZmF385EykvWtmjjeFnsk6LQKqnpcUDs1Gm/cex3d3eHxHz0mZ3/+diXjZUXJgCs2QI/2gNcmcCLGsncupxCc/T7e6yqW0HnC2s8e9F4NxrJzzbCaZkk7D1GmFgThBHxGnuQh1+9yK13PdvZV07CVgqu0X6rAW9CkL5SOOksQTUo+pedMXKOVpLcwLl/zolKMWpeqVZwD6z0hVYiGxzN5yqZtn+X5BTtxaLSvZncJHz87req9bRDlT6p+L74MiNj2H1JrLYOqz6wJ12MqgfczyfDlPls+6lTW840i7uNwevR4EM0Gny4rR4l4tXsR2OxvcnqgY9YZ3XnRZ7PdZDir1tXVXN2rhb7FEypNQn2ti47A+sbrB/pBuMbdJzeYCV1j0GF+v5kQ9DPTYhY7b/+0bn/1FadCFQRvh+Nd+vuylAZMuvUf5xKJCnPqdRhn6BUTCL9jp2z7rUqNbGp1E/O3tNiz0vU9y/pM52Nfe20y08NvmpSknPIrGwZi3q3KChkGOOwt49E6NktHxaE0mlpuiEUPh4OPZl0Zu8Hm4k+UHa4HKN0PM9J6VRY1WqTQp2zfN72r6aSnybIB4GOws1B1BsCF2dHzdFTjV+CUmZua1NtxN1Y+mi15iRYB5OLM+lI7TCJURaQ0e52ZeDvgs3k4gymBSdq/jA/QkYBGtkZewgZww+8yPBUXr5AechJGb2C0nMKdxkbKL0MnE5XGSDQZBYlLbh1Y9mDsQFWHCCjJQOBL4vCOuFiu14JFSkJXeliDboRk7rNSekmr390z5XYXHijVcJSJp3yhbOFUxzIrWryFNaHnExP4pQDdKUGxxTocfrWXYH87J7asiLwfRgWmpQR2DUZ1y1pHy/RmfVBTtfrGXm+crqq5Ph7ya4mYts46850LX20JZTQNVVeLlKM56T942WiH9Yvn1r2/QpPr797A/gmlO9t20vSpUihbD8Hg3jr/fbJULdX99cJ+K2X2qffdmtff/2AD9pkX4q4t21vIW9EJ0nCRf8Zd4agdPvNiDk9ucSq+h/MJSsy -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Get Experiment Data

- - - - - -A GET request for obtaining data on all running experiments. - -## Request - -

Header Parameters

- -Success - -
Schema
    experiments object[]required
  • Array [
  • variants object[]required
  • Array [
  • ]
  • ]
- -Unauthorized - -
- -Unexpected error - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/SDK-API/sidebar.js b/docs/APIs-and-SDKs/SDK-API/sidebar.js deleted file mode 100644 index 744c39bc..00000000 --- a/docs/APIs-and-SDKs/SDK-API/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = []; \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/api-key-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/api-key-get.api.mdx deleted file mode 100644 index b940b6e2..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/api-key-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: api-key-get -title: "API Key GET" -description: "**Required Permissions**: `ApiKey Get` or `ApiKey Admin`" -sidebar_label: "API Key GET" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1z2zYQ/SuYvbRVGX30yJuadDJpJ7Unjk+WK6/IlYgIBBBgaZvV8L93AJAy/SG3Tae6iCQWb/ftLt7iACX5wknL0mjIYTL5RF8b6agU5+Rq6b002k8mubhZWvkbteI98Y0w7vi+LGupbyADiw5rYnIe8qsDaKwJcsBo9aGEDGRwYJEryMD1XiBn11AGvqioRsgPwK0N+6Rm2pGDLnsS4eeKhCyF2QquSCzPP4gQBVfIojWNuJO+EmzEjliUyCi2ztRT6K6DT2+N9uSDm5/m8/D3GHspfr04+12cbb5QwQKFRceyaBS66GhP7Xc+ok4hg8JoJs0BBa1VssCAMvviA9ThOSMTUUOinLHkWKZA0Mr1ntq/N5Tly+lJiT6ueHZS7yADusfaqvBpqZR4++ny3ZCtZ0l9dbMeuIs7yZVApYR9aI2A9Tj8I8bWuBoZcmgaWQa78bYX7C0ykwt1KBwhU0al5KwkRUyZI4wYjadyjTHrulEKNyHI1EMn/ZfI9IZlTQEgYQ8Y/27Ppl03ntz6VCkaW46wvy2+AeOxrxNYI98PMf6DnnNFJW9pzGJjjCLU49JvUXnqMsBbZHQvoT6O6mi63kpF68Yqg+W6cer1BpsVzthLp2aL+fx+MZ/PFlOrd/9rqTKopZZ1U0O+iGchHPS6P8ynI/2Ibk8sU3BUo3yR2TGuZNF1GbDkCHDpQ61GH5KGQpd+GdTElSkhhx1xOhFVyFCvEX52GOS0gww8udtBbWOWoWK2Pp/NPOpyY+6nuPE1OlbttDB11EBPReMkt3FTCKePIL+6Hi9fBPFKvTI2OpJNYQyaXhGWMatP1TTsPUr01qRnbLgyTv4Z5XIqJpOPjWexISF1lPSUP7EKyXkTNramcamYfR5WMJnAIHywHONBP0rCwh89wGrlV6uLH2Pipd6ayKMvwAaLPekwnUIqU9yL6Xw6f85GizNLOjC4sFTIbS/4afQk2w35NJV+7vMeCQfid8btpd4lCQ2EBN1bcjI0nRfWmZ3DukaWBSrVDuMFi9CRXQZKFqR9lPme9bkz1klidG0kZo3nGvXIYsj7+18+PyVzeBhe/2Xi983AdM8zq1DqqF/pvKfWvRrGm4cM8uNd4DqDyngO64fDBj1dOtV14fPXhlzsxgxu0ckkLlcHKKUPz2WvSq/w+X6g84P4tqvCCV5D5+vQ9reomvAG/fB7uOZ01102HIgQeFpeFgVZHm18dmMIp+94+kPJuu4vlaJJOQ== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

API Key GET

- - - - - -**Required Permissions**: `ApiKey Get` or `ApiKey Admin` - -## Request - -

Path Parameters

- -A JSON Object a particular API key's data. - -
Schema
    api_key object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/api-keys-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/api-keys-list.api.mdx deleted file mode 100644 index 29b97828..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/api-keys-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: api-keys-list -title: "API Keys LIST" -description: "**Required Permissions**: `ApiKey List` or `ApiKey Admin`" -sidebar_label: "API Keys LIST" -hide_title: true -hide_table_of_contents: true -api: eJy1Vt9z2zYM/ld4fPRU29ndXvzm/bhd13bJNc1TnDmQBFtsKJIloTSaT//7DqQUK7aTZt0tL0ko4CPwAfyAnSwxFF45UtbIhZxMPuKXRnksxQX6WoWgrAmTyULcLp16h614rwLdCusfD5ZlrcytzKQDDzUS+iAX1ztpoEa5kMF6kplUjP6lQd/K7ODOTxUKm3/GgsQdtoKsYB9BFQqPodEURN5OZSZDUWENcrGT1LqITV6ZrcwkPkDtNB/FW7sue3L/GkJxGMMRWG6tRjBjNPINjrEcbPGbOMoQbtGPcc7GIIqwDt+D8lPX3WTSY3DWBAxs/ON8zr+e8rkUf1ye/ynOE6VfFVUCjADvoRV2I0BrUXgEwlIsL94y54HZLawhNMR44JxWBTDe7HNg0N1xhKlkXHdvHXpSKaSU3nEiXZboO5VirYyqm5qJyiRZAn0aAJxac7ijrzEtZvPg2ueiK08jp9q81FhLrcUvH69+jZy9w5a9nvD+orMZqO7robVw+/fFWHfYnsLYWF8DyYVsGlVGEkduJ+wdEKHnNkg1zrBUlJWokTDzCBGjCViuIZbaNFpDPjR79vz9JRC+IcWvK+uxB4x/55O36yagXz9XisaVI+zvi2/AeHrXM1iju/cxfruVwBeVusfyZQnZgA7IrXsPBP4U6tOoHk3XG6Vx3ThtoVw3Xr/cYLPCW3fl9exsPn84m89nZ1Nntv9rqQ6ebYkOPNW9gjwf6Qfwd0gqBYc1qJOZPcaVLDrWBUUR4CpwrUYHaQ7Jrv/JZI1U2VIu5BYpPYmKKXpUj0wG9PfDnIrcyorIhcVsFsCUuX2YQh5q8KTbaWFrycIbsGi8ojY6cRD9vYvrm/HnS9bJ1CFjo71gpYNe/yuEMnJ5KOHsO0iN2Nj0NzRUWa/+jso8FZPJhyaQyFEoE8dlYk2smJI37NjaxqcS9smv5GQiB7mTyzHeMIX4w189wGoVVqvLHyLdymxszKOnPYfiDk0pM8lUprjPpvPp/DgbI84dGs7g0mGhNv1sEVQBiWSbY4gpLH/ueY8Jc+Jfrb9TZpuEkxMS+ODQK261IJy3Ww91DaQK0LodJhkU3IddJrUq0IQo7n3WF946r5DAtzExZwPVYEYWPe9BvH97+ekwnd1+Uv6ndanvB8IHmjkNykThSg89tez1fuDdZLKygfhst8sh4JXXXcfHaYPgnixVYB0pe9F5IexXb1wnY4yTatjr7kE3bCJ5wzmKYG/ar2CvMe+3rNeYDrvU3vaG//EqCer1TZcNT4wZSk7LokA3jv1o3WGURxH5/bdPsuv+AXftzm4= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

API Keys LIST

- - - - - -**Required Permissions**: `ApiKey List` or `ApiKey Admin` - -## Request - -

Query Parameters

- -A JSON Object with an array of all created API keys. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    api_keys object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/application-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/application-get.api.mdx deleted file mode 100644 index 00700758..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/application-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: application-get -title: "Application GET" -description: "**Required Permissions**: `Application Get` or `Application Admin`" -sidebar_label: "Application GET" -hide_title: true -hide_table_of_contents: true -api: eJztXV9z2zYS/yoYvLTxqbYSd6Z3elNv2l7vpk2mdu7F8jEQuRIRkwALgLZVjb77DUBKIiWKlCgptpR9yEQmgcUC+O0/AAtOaQDaVzwxXAraoxcXf8CfKVcQkA+gYq41l0JfXPTIp36SRNxntiD5BcwnIlX5YT+IufhEOzRhisVgQGnau5tSwWKgPcqWRX8NaIdy217CTEg7VOWN0p5RKXSo9kOIGe1NqZkktjIXBsag6KyzwvBtCIQHRI6ICYEU2TEhM2QiU/LEdUiMJGMwJGCGkZGS8SWd3dt2dSKFBm2betft2v/K9Pvk3zfvfyfvh5/BN4QJUujGN9rRu6Qd6kthQBhbv1Dg6rO2RKbr/ZGOnh0rJRNQhmcsFOo2F+ZB9QBl4714o43iYkw7FJ5ZnESusNRrI1lX/n2qCH9/Y/tu6/kKmIHAY6aq2kiq2L6hATPwneExFOsMJ1uMgvJD/gjF7g2ljICJIlcjFmmYdSh7ZIapKqoijSI2tGUtqhZFvRGPwEuTSLLAS1VU3/crX8nko4qu3na7z2+73au3l4kY7z8MXqpBeZVz2KExFzxOY9p766YpYcrEObw2c/obUw9geMYcxIxX9mzBV1ZiNutQw40j8FFnANqKyVmHpkmw2wBUTMmcBuLileOidu6KTJeLdSpws9s8wnMCittu6kIFphSbWCtiINbN0FkSaalXC4y93UrHGtDGKzQ7c7yqVd2+YW61YaahAZUKkU9qAI8QycS2s5cwasPUvhRk0p5AoXv2xaxDR2kUeVLkJDdAq0G25jQemeJM1BGqmIxuh8bsOft9PevQiGnjaQDhceH5MoC9hkuoOVe6GhOLpov4KAyTZSkB5YMwbAy6ipOEGQPK+jKDQTB9NxsMrlZ+lGB1/f3V9fXV9XUVu8uWPDnyjGKjEfcbhKXbtbCAkrSvj9KQj3kmJDlVb4cq6I+csd1pyST6Jl8XRqp9kRomK4Z663joNuSaLG27jQMLVS03ghsvq3+8KG7ez904t+GytvGyTBWxJPRRcbEmiu1seFtXE9X86YjwLuNfrC64ubXFi3K3qYclJz5RPGZq4sVgVMmP2VFUx5JFjQ3+0N1KqG95DHax6kcpH3aWbBbLVBi3GGbJDGEkFRBGhlI+cDEmIdNkCCBIzAI3XisqqoKs65ul5hnpMT/k8AjzeAZGIztMVfWFRdEdTaTmhj866wpjlv9MxYOQT4Le7xwLZijytFH1XE9nTqtpn0WwDQ7A57o8wiKNh+WSdv4eWZSCp2WqfPBycEzqWaGzBYwmVgUYaOD9yDJe6vlLqmaLrGOaxyRVfsg07CRFfWLZIiOpiFHMz6RGPpGYiQmZU9SEKXAyRKQg9k1uTgvLtwewqmixXrvFwoVSxEX7hdI1pteHe6d5NGy8xwrpZidmoaupz5WfRkx9+4tk0Ruaez6GjWsr2gLtFX25cpWe1xM/lJEcc59FvVuValwUOncZe7HoE3HxqnFxQN1rNVeNOi3rQvvvlo3flDjKH649Kz0HFn9ppW3b3FjJvmyvrOHZbjUseGoOAprd+BIwUKmfsfCiQ424OLJSz9a7W6vbekxqqJxzRNKrQdJsK+O3tJi3wOI3dIWKfehIb3kwpXj0ZEn6p8XTN7RIakfemjqU871sbcH9Tv7NYiCypfI9RCgjsJHh+VL8svnf3JMt/Zaaqcvo5N0vPF8MSMltmz+UT2IvjVEbOKMmOWVNUmMMVtD03oLIPW0Un3XcrxKje6/0tF5piWS2tt37F7Cg7LCd177xutrIw7V91UGD9kP/4sS1whpwlqK/Z6R/XLuJ8T5KC8b7iItXgQuM9xFJGO9/4Xj/ADsNbZ0IPMqDeuLF9QR6IogLPMqDR3lQxk5F9+JRnrPGxbkd5dmwoYYbTAj/V7jBtFfUXNpB3ZmjnFzdFu2mvdzsOV1L7WrMhXlnk3tYGnAQfmUsWkyinw5olsczoL0pE0FvMLi7n81ogYTNUOKl1KgayQkniTQhaF6Rvp9lJwXcr453bZPulZdIXl6XWJbgtjmLWxfNegEYxqPqopaPivSk2UIUbG3wjRVnby39qzL9f29fuBSJb4Gi5dpH4TYoh8+KqxZ21La+FCPe4MTSWfP6zs63ifwBAfkxNSZLLy7cZLFZZ5VvrqhcHPpvTmfmrmjwpQiWMnOgy1b2WAHDtMzNZDEtE9MyMS0T13LRcca1XMQFruXiWi7K2MvLGK7lIi6+hrXcoyhtPKaJwvsahRcdasQFHtNEJOExze15w7RMTMtETfLV7ZpjWuZRNycwLRO1QiutgGmZGO+jtGC8j7jAeB+R9OJIwngf0zLxKA/qCfREEBcv7IngUR48yoMyhkd5EBdf6VEeTMtE+J/OBtOpp2XWLpdXBso387S0OZEsMeiRw9PLZ6iBeORKClcmeztd5FgVvsmdNR+kWRLn/fw7hb7NCqsEeMU3jkdcZd8TlzpVsJetdZ+wPgilgBnm+amRo9FBrH97GpXY+ZDhpIiZqs9tY3YjZjdidiNmN+KSKIZfJ+B/4pIo4gKXRHFJFGXsVHQvLomeNS7ObUn0KEobTzui8L5G4UWHGnGBpx0RSXjacXveMLsRsxtRk3x1m8+Y3XjUzQnMbkSt0EorYHYjxvsoLRjvIy4w3kckvTiSMN7H7EY8yoN6Aj0RxMULeyJ4lAeP8qCM4VEexMVXepQHsxsR/qezwXTW2Y17ZAvWfu5v+Ym/s0krdAlPhR4s0qKWxcHncYaa2KqGLctmA+lvTTtZcLKhI+u1R5FkbmR5nDC/bhAa63qRfMpUZmsKaZK0o1D3uchiWmXjBtNBF6ZwxwiN4unECrhOc9a4wB0jRNLJ7hhVmeIFWdy1wV0blFX0BhAXuGuDuzYoY69FxnDXBnGBuza4a4Pw/yK7Nm1tN95Mt1Yfb6bDm+m2upmu4uIMTLs76shj2h1a3VZW91TT7lqkqy/uXn7hUxsHGjh0bNCxQcfmyzo2uOODq44nauhxxwdxgTs+uOODMnY6uhd3fM4aF+e243MUpX3AyBy3nlAOX2HCEC6N49I4aoXXpxXaL4035+Ut0+2OeTVr+ytvmmXjQClRKAivXxAadNk6jJaCUkBAk5071NcsSy0e0YBqw/yH3pD5DyACjOHPXwgwhkdctI/hm7eYWqc8Fez3alRferWuHnfQ6SuU7KaWNHCEyEVBEk08I6sGbTF79kWntoHlQLlVhLX+/C4NFJvzbHe2W29Z4aM0qnvZLubP9/zmW9KZANDOytUK2jBl/1cw/wUBz17IxKI2jSJPWvn3ZZzXydWE29Ge/75Hs3Xe6gm3/RAXR156tnqzioW1gnUXwKxThSevqFXr0dSk7Jtb2NpKL+xFoe7KEGxhsq312WSpM8u0ziHaW7S3qFdft15Fe4u4QHt7ovZ2xB6l4nZODnCVDQrkqxbIpkXtA3kYuw/eCqM/55gsyJYtwiJQ9d9SaOcMHuqiO/ek4FZZVKeJJwACCKxzlAYchA9ezHXMjB9aX8rNsKf5X+ApYH7oSuZPld2sXpZu60gdwujGYFjADNtCCVfqm76dOzeLhR7XKMMNU/hiCD3MKCr4M+UKAm9lENaUxOp9n8WkgO4/3l1/74g5uLRnaD3EWJJswWE98UpU3LgSN7aNpe32tK9A6FDuI+tNIFjJsqhzGxYF37l8FQUZcyVT09jG9+6a1SE0WKT8nk7yz2800eBLERBuwOkBsa2qKvDVXidmRDQbQ3sa1QkgTvxkkmzrAyhwylEKL4CYiW3TkJaDsNXGws88go+ueNljcs/dMJQGZaNmeeKBCRuw0P27TVQKgY/DBsT98K47b3aDIM5fNyfb5A7SZxkKL5Cw8HSkMMVrjTcT4DEbw1Vebcg0bHKwFqrBvs+n24tgVOxszQW4rrhdYti+9OqoN5VfG/vaCrh0cc4e8bZLF/lw7hkl4Wy/8Om2opPR6GVUmdjcRN8s6lcYjMz41l7FvaxfPsRWjHk6tJCuWOSmv3y87arvssZWZR5BraTb1lxGX+3xF1gv9XDlxWyWnysOZWCzmcEJDbP6nF4V0zWvpoW/fg1mNk4C9ejE8W7qjE2PhsYkund1pZkIhvL5kg11zJSJJpe+jOns3tbxU8VtTvDd1MGin/D/gP3zvvj6xg8hzmS2WGiJlOxBh3I7M2F2nngljZX2ia1L+h9+Jf+BictZtb9ZakKp+F+uJ5fk4uK3VBsyBMIFMSGQbIDJgPYT/p2tOJFppnk8lnDvASYDenFB5x4W7Rfp2WFxvNMe/V9OYDDQg8HN39xMcTFy2x7z6Zgf5urQxZzTt5fdy+56bwR5n4CwPbhJwOejfC6ICZkhWdkhaNeF/o/5uLsO244/SeVydZ+4CV2HSOHsB0mUHCsWx8zYHLFockkz1yS7iN86z9wHobOQMev1ByUTxcEwNXEdS6Q2cfZFgfm4LPFCfvnpdrVD07nzQ3v04uKPPDYjH0DFXNuR0BcXPfKpRAXMJyJV+WE/iLn4RBexq4Fnc5VEjDuXPdfCGaLvaCkBuUN7JUzT+w4NpTa24HRqfayPKprN7OM/U1AOpLkKc7r/bkoDru3vIDcaNV38dt7DN8TeRMADdwuBnatCX9xUTmRKnrgO7S0HYzDEBv5kpGR8uamTc6EQViLyTy9Q2qEPVmZouY+ze+f9OoGxPcjK9H0fElOoXah09VlbXXFfUBN2Omez/wOlMQTP -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Application GET

- - - - - -**Required Permissions**: `Application Get` or `Application Admin` - -## Request - -

Path Parameters

- -A JSON Object an application's data. - -
Schema
    application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiments object[]
  • Array [
  • experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • new_experiment_notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/applications-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/applications-list.api.mdx deleted file mode 100644 index f4e82f47..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/applications-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: applications-list -title: "Applications LIST" -description: "**Required Permissions**: `Application List` or `Application Admin`" -sidebar_label: "Applications LIST" -hide_title: true -hide_table_of_contents: true -api: eJztXW1z27gR/isYfGnj6mwluc61+qbr3F2v95LM2ekXy2UgciUiJgEGAG3rNPrvHYCUREoUKVFSbCmbmUwUElgsFs++4GXBKQ1A+4onhktBe/Ti4g/4nHIFAXkPKuZacyn0xUWPfOwnScR9ZguSX7k2H4lU5af9IObiI+3QhCkWgwGlae92SgWLgfaolsrQDuW2nc8pqAntrLR+EwKRw0/gG3IPE2IksXWICYEo0GlkNBlOLmmHaj+EmNHelJpJ4mgbxcWYdig8sTiJ7CPX6mzWKbXvMe2v8rBGbChlBEwUqRmVQpFWwsbQSIcLA2NQRTqvi0S4gVi3ofL32eyuQxXoRAoN2hZ+0+3af8ry7JP/XL/7nbzLRPrITUiYIEwpNiFyRFgUEbYcP01MyAwJ2QOQIYAgvgJmILAC96UwIIxtolDj6pO27UzXmc5G0UJByQSU4RmXWY/X+zbrZBKt6nXMBY/T2MquQ400LKomUOxJoYTrrRXyStObOAyqqWdDVoc3LrUtWBqBuvLvUkX4u2s7ArZeLmyPmapqI6li+4YGzMA3hltoL+sMJ80dY8oP+QME9TgfsUiDFeYDM0xVURVpFLHhQifmRb0Rj8BLk0iywEtVVN/3K1/J5IOKrl53u0+vu92r15eJGO8vBi/VoLzKMVwBUgAJUybOMb2Z09+YugfDM+YgZryyZwu+shIzi1RuHIEPOgPQVkzOOjRNgt0EUDEkcxqIixeOi9qxKzJdLtapMn87jSM8JaC47eYetnJJpKVdLTnGbWysAW28QrMzx6tiK9Z2w9hqw0xDAyoVIh/UAB4gkoltZy9l1IapfSnIpD2BQvfsi1mHjtIo8qTISW6AVoNuzWk8MMWZqCNUMRjdDo3ZU/b77axDI6aNpwGEx4XnywD2EpdQc66qQo1i00V8FMRkWUpA+SAMG4Ou4iRhxoCyMdZgEEzfzAaDq5UfJVi9/fbq7durt2+r2F225MmRZxQbjbjfoCzdroUFlLR9XUpDPuaZkuRUvR2qYDxyxn6nJZMYm3xdGKmORWqYrBD11vOhm5BrsvTtf9GkWNVyI7jxsvrHm8XN+7kb50B4oO2UWqaKWBL6qLhYU8V2PrxtqIlm/nRUeBf5F6sLbm5s8aLebephKYhPFI+ZmngxGFWKY3ZU1bFkUWOD33W3UuobHoNdTfxeyvudNZvFMhXGKrcdeDKEkVRAGBlKec/FmIRMZ8tlMQucvFZMVAVZ1zdLzTPSY37I4QHm8xkYjayYquoLi6JbmkjNDX9w3hXGLP+ZinshHwW923kumKHI00bVcz2dOaumfRZVr9St4AB8rssSFmk8LJe04/fAohQ8LVPlg5eDY1LPilswzEtaE2Cggfcj63ip589pmi2yjukek1T5IdOwkxb1iWWLjKQiRjE/0xr5SGImJmROUROmwOkQkYLYN7k7La3r4sTk7D0WLpQiLtovlK4xvS7uncbRsPEeK6Sbg5iFraY+V34aMfXXnySLXtE88jFsXFvRFmhv6MuVq+y8nvihjOSY+yzq3ahU46LQuevYs80+ERcvGhcHtL3WctWY07IttH9v2PhViaP84dqz0nNg8Zc22rbNjZXsy/bGGp7sVsOCp+ZJQHMYXwIGGvUzVl4MqBEXRzbq2Xp3a3Nbj0kNlWOOSHoxSJpt5fyWHvMGWPyKrlCxDx3pLQ+mFI+eLEn/sHj6ihZJ7chbU4dyvpetLbjfKb5ZCCJbKt9DhTICGxmeL8Uvm//NPdkybqkZuoxO3v3C84VASmHb/KF8FHtZjNqJM1qSU7YkNc5gBU3vLIjc00b1Wcf9KjG690pP65WWSGZr271/AwvKAdt57Ruvm418uravOWiwfhhfnLhVWAPOUvX3nOkf12/ifB+1Bef7iIsXgQuc7yOScL7/hef7B9hpaBtE4FEetBPPbicwEkFc4FEePMqDOnYqtheP8pw1Ls7tKM+GDTXcYEL4v8ANpr1mzaUd1J05ysnVbdFu2svNntO11K7GXJg3NrmHpQEH4VfORYtJ9NMBzfJ4BrQ3ZSLoDQa3d7MZLZCwGUq8lBpVoznhJJEmBM0r0vez7KSA+9XzXduke+UlkpfXJZYluG3O4tbNZr0ADONRdVHLR0V60myhCrY2+Maqs7eW/lWZ/r93LLzdZUlVKy2FC78cPiuuWtjR2vpSjHhDEEtnzes7O98m8gcE5PvUmCy9uHCTxWabVb65onJx6L85nZm7osGXIljqzIEuW9ljBQzTMjeTxbRMTMvEtExcy8XAGddyERe4lotruahjz69juJaLuPga1nKPYrTxmCYq70tUXgyoERd4TBORhMc0t+cN0zIxLRMtyVe3a45pmUfdnMC0TLQKrawCpmXifB+1Bef7iAuc7yOSnh1JON/HtEw8yoN2AiMRxMUzRyJ4lAeP8qCO4VEexMVXepQH0zIR/qezwXTqaZm1y+WVE+XreVranEiWGPTA4fH5M9RAPHAlhSuTvZ0ucqwK3+TOmg/SLInzbv6dQt9mhVUCvOIbxyOusu+JS50q2MvXuk9YH4RSwAzz/NTI0egg3r89jUrsvM9wUsRM1ee2MbsRsxsxuxGzG3FJFKdfJxB/4pIo4gKXRHFJFHXsVGwvLomeNS7ObUn0KEYbTzui8r5E5cWAGnGBpx0RSXjacXveMLsRsxvRknx1m8+Y3XjUzQnMbkSr0MoqYHYjzvdRW3C+j7jA+T4i6dmRhPN9zG7EozxoJzASQVw8cySCR3nwKA/qGB7lQVx8pUd5MLsR4X86G0xnnd24R7Zg7ef+lp/4O5u0QpfwVOjBIi1qWRx8Hmeoia1p2LJsJkh/a9rJgpMNHVmvPYokc5LlccL8OiE01vUi+ZiZzNYU0iRpR6Huc5HFtMrGDaaDLkzhjhE6xdOZK+A6zVnjAneMEEknu2NU5YoXZHHXBndtUFcxGkBc4K4N7tqgjr0UHcNdG8QF7trgrg3C/4vs2rT13Xgz3Vp9vJkOb6bb6ma6ioszMO3uqJLHtDv0uq287qmm3bVIV1/cvfzMpzYOJDgMbDCwwcDmywY2uOODq44n6uhxxwdxgTs+uOODOnY6thd3fM4aF+e243MUo33AmTluPaEevsCEIVwax6VxtAovzyq0Xxpvzstbptsd82rW9lfeNOvGgVKiUBFeviI02LJ1GC0VpYCAJj93qK9Zllo8ogPVhvn3vSHz70EEOIc/fyXAOTziov0cvnmLqXXKU8F/r87qS6/WzeMONn2Fkt3UkgaOMHNRkEQTz8gqoS1Gz77o1DawFJRbRVjrz+/SQLE5z3Znu/WWFT5KUt3LdzF/vuc335LOFIB2Vq5W0IYp+6+C+S8IePZCJha1aRR50uq/L+O8Tm4m3I72/Pcduq3zNk+47Ye4OPLSs7WbVSysFay7AGadKjx6Rataj6YmY9/cwtZeeuEvCnVXRLCFy7beZ5OnzjzTOofob9Hfol192XYV/S3iAv3tifrbEXuQitsxOcBVNqiQL1ohmxa1DxRh7C68FUZ/zDFZ0C1bhEWg6r+l0C4YPNRFd+5JIayyqE4TTwAEENjgKA04CB+8mOuYGT+0sZQbYU/zP8FTwPzQlcyfKrtZvSzdNpA6hNONwbCAGbaFEa60N307dm4UCz2uMYYbhvDZEHoYKSr4nHIFgbcihDUjsXrfZzEpoPvPN2+/dcQcXNoztD7FWJJswWE98UpUXLsS17aNpe/2tK9A6FDuo+tNIFjJsqgLGxYF37h8FQUZcyVX09jGt+6a1SE0eKT8nk7yr79oosGXIiDcgLMDYltTVeCrvU3MiGg2hvY0qhNAnPrJJNk2BlDgjKMUXgAxE9umIS2FsNXGwo88gg+ueDlics+dGEpC2WhZHnlgwgYsdP9hE5VC4OOwAXHfvenOm92giPPXzck2eYD0SYbCCyQsIh0pTPFa480EeMzGcJVXGzINmwKshWmw7/Ph9iIYFTtbcwGuK26XGLYvvSr1pvJrsq+tgEsX5xwRb7t0kYtzz1kSjvYzn24rBhmNUUaVi81d9PWifoXDyJxv7VXcy/rlQ2zFOU+HFtIVi9z0l4+3XfVd1tiqzAOolXTbmsvoqyP+AuulHq68cH/cBCOUgU1nBqc1zBp0elXK1+xQDerB6d/t1HmXHg2NSXTv6kozEQzl0yUb6pgpE00ufRnT2Z2t46eK2yTg26nDQT/hv4D9713x9bUfQpwpabHQEhrZgw7ldijC7ADxSt4q7RNbl/Tf/0x+gYlLUrW/WWpCqfifrh+X5OLit1QbMgTCBTEhkEyiZED7Cf/GVpzINDM1Hku4dw+TAb24oPOQivaL9KxYHO+0R/+XExgM9GBw/Tc3NFyM3D7HXP7z01sduhhk+vqye9ld740g7xIQtgfXCfh8lI8EMSEzJCs7BO260P8+l7vrsO34o1QuOfeRm9B1iBQOe5BEybFiccyMTQqLJpc0i0Wym/dttMx9EDqbI2a9fq9kojgYpiauY4nUJs4+ITCXSwEt5Nefr29WuzSdxzu0Ry8u/sinY+Q9qJhrKwt9cdEjHwt0yK9cm49EqvLTfhBz8ZEu5qsGnsxVEjHuwvTc8mYgvqUlEN91aCi1sc+nUxtGfVDRbGYff05BZSgNuLbGPcg9QU0n7J0CmVMg9zCx1xJoqYwbEQU6jYwmQyfbSj7vLcKprUEX326w2e0VHCyLekz7WxZPbOC8XdHM4hbL3uXG2nm52zsXMjulsxLKKvV9H5Ii7wVJX33S1sDcFUzLTz/c0Nns/8dvhdY= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Applications LIST

- - - - - -**Required Permissions**: `Application List` or `Application Admin` - -## Request - -

Query Parameters

- -A JSON Object with an array of all applications that have been created. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    applications object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiments object[]
  • Array [
  • experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • new_experiment_notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/backend.info.mdx b/docs/APIs-and-SDKs/Web-Console-API/backend.info.mdx deleted file mode 100644 index 37e74f84..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/backend.info.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: backend -title: "backend" -description: "An OpenAPI Specification that describes the ABsmartly API for working with your experiments programmatically." -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; - -Version: 1.0.0 - -

backend

- - - -An OpenAPI Specification that describes the ABsmartly API for working with your experiments programmatically. - -

Authentication

- -A User API Key for API authorization. **Must be in the format "Api-Key your_user_api_key"** - -
Security Scheme Type:apiKey
Header parameter name:Authorization

License

- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/cors-allowed-origin-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/cors-allowed-origin-get.api.mdx deleted file mode 100644 index 8f35967f..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/cors-allowed-origin-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: cors-allowed-origin-get -title: "CORS Allowed Origin GET" -description: "**Required Permissions**: `CorsAllowedOrigin Get` or `CorsAllowedOrigin Admin`" -sidebar_label: "CORS Allowed Origin GET" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1z2zYQ/SuYvbRVGX30yJua6WTcTCpPHJ8sV16RKxIRCSAL0Jaq4X/vLEjZtCU7nWmrg0QC2H379uNBB8jJZ6xd0NZACqPRZ/rWaKZcXRLX2nttjR+NUnX33rKfV5V9oHzButBGfaBwpyyf25rntTZ3kIBDxpoCsYf05gAGa4IU0LlKZyigFzkkoAXbYSghAe4DgDRwQwn4rKQaIT1A2Dsx1iZQQQxt8iL4LyUpnSu7UaEk9X7x+Ur1Uak+rFBiUHvbqAftSxWsKiioHAOqDdt6DO2t4HtnjScvkL9Mp/LzHGeufr9a/KEW66+UBZVZE1AbbQqFymtTVGexf/ARaAwJiAWZII4HiZh89eL9cErYRiBJJltHHHQXW2bZr7ADWdkI8n0jnZ/PZLdyADJNDekNMBW0gwS8o0xvdAa3CdAOa1eJ4eNqm8AJsg+sTQEJbCzXGCCFhquTap0ef3K/aFiVtiaHBYlhxoSB8hWGN2FyDPQu6PqZzXq/ajzx6jXijcsHvk1TVbiWILrm+2dYRx/PsV7xNcB+ivH7hUPOSn1PQxZraytCM0zdBitPbQJ4jwH5nNfnUT0eXW10RavGVRbzldTrzQJNMrbumqvJbDrdzabTyWzsTPG/liqBWhtdS3fOYi855FD3Y/R6pJ+QtxR0FxzVqM8ye4yrO9HKQOgQHVx7qdVgQWYb2u6TQE2htDmkUFCsmWiY5Meynxzk+yJvZYyI748aGLMLZQjOp5OJR5Ov7W6Ma18jh2o/zmwdhchT1rAO+2gkYcyd/kjyejvcvhK56HpkeOiRJHYLvciWhHnM5ktJE1s1v7xQH2mvNrZ7xiaUlvVfUaDGajT61Pig1qSilpLq8qaWMHf6nRjubcNdEdHp1Zb2SxiNpOs63Z8P/UGv7bLxZ+9gufTL5dXPMeHabGzk0Sd+jdmWjFwXksou7tl4Op6esjFq4cgIg6teqSJip//d2TX5SGH+a5/3SFiIP1jeipo/6FBGQop2jlhLs3nl2BaMdY1BZ1hV+6OgYyad2CZQ6YyMj2Las75k61hTQN5HYs76UKMZnDh3V3347ctLYoenq+O/v6n7dgm0CxNXoTZR2Tol6Nr6Jl45kEDaNbbcCaX1QXYOhzV6uuaqbWX5W0McOzWBe2TdCc7NAXLt5TnvleoNfj8e6f2k/v29/gq744QYGY97rBp5gwS2MkAv/qS0t21ynB5h0p2ZZxm5MLA+udBlVB9FQmratn8DEXtCKw== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

CORS Allowed Origin GET

- - - - - -**Required Permissions**: `CorsAllowedOrigin Get` or `CorsAllowedOrigin Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a single CORS Allowed Origin's data. - -
Schema
    cors_allowed_origin object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/cors-allowed-origins-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/cors-allowed-origins-list.api.mdx deleted file mode 100644 index 3630f865..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/cors-allowed-origins-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: cors-allowed-origins-list -title: "CORS Allowed Origins LIST" -description: "**Required Permissions**: `CorsAllowedOrigin List` or `CorsAllowedOrigin Admin`" -sidebar_label: "CORS Allowed Origins LIST" -hide_title: true -hide_table_of_contents: true -api: eJy1Vt9v2zYQ/lcIPnqq7QzYi9+8Yhi6tnNQp09x5pyls8WaItkjlVgz9L8PR8qJ/CNpMKB+kUUdv/vuu+Md97JAn5NyQVkjJ3Iw+ILfa0VYiGukSnmvrPGDwUTcv7fkp1rbRyxmpDbKiE/Kh3th6dK3aVEpcy8z6YCgwoDk5eR2Lw1UKCfSWwoyk4p9fq+RGpmdMLkpUdjVN8yD2GIjghW8R4QSBaGvdfBi1QxlJn1eYgVyspehcRE7kDIbmUncQeU0L0WvbZsd+V+Cz085nIGtrNUIpo8WqMY+loMN/hBHmYAbpD7OVR9EBaz8/0H5rW3vMknonTUePRv/Oh7z41jPqfhrPvtbzJKkuTUBlFFmI8AIIIJG2LUArcX72Ze56JIpUjY968xb0ARGBue0yoGRR988w+/PuabkcQWQdUhBJXIp0POQ2iwJeSnYShlV1RVLlslgA+jLALklv4REfWkT9Z5lDJM1PqHwEtPispe0spdomNKtJNzgjrPlMFdrlcu7fuk9rbaZTJQuleraUgVBTmRNmi2PcvdaZc9qEqWtMGrHEhBCwGIJ4VU3BQR8F1R1tGfVLGuPtHwp8NoVPWxTaw2rw4HI3ujrgHHs6wWsfmqfOP44cUB5qR6weP0Yr0F7bDMJDxCALqEes3oyXa6VxmXttIViyfl6NUGjnKz7Snp0NR7vrsbj0dXQmc1PTdXJgSnQAYWqO7svM/0MtMWgEjmsQF2M7IlXsmj5QKgQAb56zlVvgVuJbLtfJisMpS3kRG4wJg1CGQWyxJ3PIz0cpkRUVZYhOD8ZjTyYYmV3Q1j5CijoZpjbSnLb85jXpEITN7H7qVMfkV/v+p/n3JtSbfSNnhtDWui6b4lQRBVPGyjvFdPrD+IjNmJt03+oQ2lJ/Ru74VAMBp9rH8QKhTJxWCW9xEJOnXrHGxtbU0oeOLXcYrOQgwFXWxoE0z7eYQbwh386gMXCLxbzX6LQyqxtjKMTfAX5Fk0hM8lSJt5Xw/FwfB6NETOHhiOYdx0qehShhCCS7Qp9DGH6e6d7DJgDf7S05dnxqEIZAxK4c0iKi8wLR3ZDUFUQVA5aN4fpATlXYJtJrXI0PjbRLuprso4UBqAmBuasDxWYnsWlsSQ+fZjfnIa2f55UP+E601VMwF0YOQ3KxKaWmkAq6Ns4hngIlNYHft/vV+DxK+m25eU03bliC+W5vxRdM3olkDffhi7y23K1H+5cD6BrNpF8+zhj8GzaXY/eYt7dgN5ierjnPNve8Qup1Ghv79rscABZobRpmufo+tzPLiCM8tRe/vzjRrbtf7PxuC8= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

CORS Allowed Origins LIST

- - - - - -**Required Permissions**: `CorsAllowedOrigin List` or `CorsAllowedOrigin Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all CORS Allowed Origins. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    cors_allowed_origins object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/environment-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/environment-get.api.mdx deleted file mode 100644 index 60819232..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/environment-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: environment-get -title: "Environment GET" -description: "**Required Permissions**: `Environment Get` or `Environment Admin`" -sidebar_label: "Environment GET" -hide_title: true -hide_table_of_contents: true -api: eJztVktv20YQ/iuLuTRVGT165E0FgiINUhtVfLJceUSOxInI3c3uUJYq8L8Xu6RsypKdtGiBHqqLyOW8vnnsNwfIyWeOrbDRkMJg8Bt9qdlRrq7JVew9G+0Hg1Tdv9NbdkZXpEX9THKvjDs9nOYV63tIwKLDioSch/T2ABorghToSfR9Dglw8GdRCkjAdU4hFVdTAj4rqEJIDyB7G5RZC63JQZM8C/hTQYpzZVZKClL9cKRAUXtTqwf2hRKj1iQqR0G1cqYaQnMX/HprtCcfXP04Hoe/U/tT9cvs6ld1tfxMmajMaEHWrNcKlWe9Lkn1cH3no4MhJBAkSUswiNaWnGEwOPrsg9XDOUATHYTkOWPJCbcx9Yx/XZjzyxlrC/D4xYtjvYYEaIeVLcPRDHW+NLuz9L6mc1U75Vu9fg6GwUirFcKvK0hvIactlcZGGDHqvM6ih7smAXRZwVvqB780piTUfX8rLD01CWSOUChfoFwKb2VcFb5AjkJvhSuCns5yv6g9ucVLiapt3rOt67LEZfDdNuW3+TraOPX1gq2e76cYv17ov5Yx3KKgu2T1NKpH0cWKS1rUtjSYL2pXvt4Ho8wZe+PK0WQ83k3G49FkaPUa/s1SJVCx5ir01iS2rEUnz2bkQqQf0W1IuA2OKuSLyB7jaiWa0M4s0cCNP+2T/2v1H6/VWdp6Aj2ugKb9JVCRFCaHFNYUSxnoKYVR737zo8MJkzWQgCe3PbJdrAEUItano1F3QQ5x6St0Uu6Hmaki9XjKaseyj0oh2KnlDxRe7/qfZ4Eo2k7qCz2mAtuDjk4LwjzCfk5iQVdNr9+rD7RXK9M+Yy2FcfxHpKahGgw+1l7UkhTryKZtdtUcppbfBsW9qV1barS82NB+DoMBHAkGpn170LF4+PB7Z2A+9/P57IdYJ9YrE3F05VhitiEdFoOQyjbuyXA8HJ+j0erKkg4IZpYyXnXk2jJ+K7skHyFMf+ryHgEH4A/GbQJ/P7AUEZCinSXHsbbKOrN2WFUonGFZ7o9Ujlno1yaBkjPSPpJbh/raGeuYBN0+ArPGS4W6J3GyOb379BzQ4WlZ+Gf2r641hHYysiWyjndWeze0HX3bXyw8JJCebmd3CRTGSxA8HJbo6caVTROOv9TkYpMmsEXH7WjdHiBnH57z7ip7BeKbI8Lv1d9f3l4AeRwKHSZii2Ud3iCBTZiZZxtoE3aPbmACglZmmmVkpad9tr2F6Xy8JkI5m+ZP08rpPQ== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Environment GET

- - - - - -**Required Permissions**: `Environment Get` or `Environment Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a single environment's data. - -
Schema
    environment object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/environments-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/environments-list.api.mdx deleted file mode 100644 index a7ab2721..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/environments-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: environments-list -title: "Environments LIST" -description: "**Required Permissions**: `Environment List` or `Environment Admin`" -sidebar_label: "Environments LIST" -hide_title: true -hide_table_of_contents: true -api: eJztVk2P2zYQ/SsEj65iewv04psLBEWapLuod09r1zuSxhZjimTIkbOqof8ejCiv5Y/dbIIW6KG+2CZnHue9GXJmJ3MMmVeOlDVyIgeDP/FzpTzm4gZ9qUJQ1oTBYCIe3pqt8taUaEh8UIEehPXHq9O8VOZBJtKBhxIJfZCT+500UKKcyGA9yUQqPudzhb6WycnptwUKm37CjMQGa0FWsI+gAoXHUGkKIq2HMpEhK7AEOdlJql2LTV6ZtUwkPkLpNC+1pzZNcnT+EkJ2GsMZWGqtRjB9NPIV9rEcrPGbOMoQrtH3ca76IIqwDD+C8kvTLBLpMThrAgY2/nk85q9jPafi99n1H+I6SppZQ6CMMmsBRoD3UAu7EqC1yDwCYS7wkM3AOrMLGmJkcE6rDBh59Ckw/O481pg8rgBvHXpSMbhI9JxSk0QhL5EtlVFlVbJkiSRLoC8D9EPuWbT0WNuTo5+LML+MHjP1UpnNwOSpfWTjI/Ff8rmuvAjRry/5kEGi106iYfL3Msctaut4P0adV1l7wqJJJPisUFvMXy7eFeiATSK7LC+BLoW3sr7kHZkD4RtSfHsOPmm9rAL65XNCVS7vYZtKa0j3Fyd55Vl7jOOznsHqnX2I8duJ/j7FYAsE/hLqcVRPpsuV0risnLaQLyuvX66DUeatu/N6dDUeP16Nx6OroTNr+W+m6uRi5ejAU9nd8ecj/Qh+g6RicFiCusjsKa5o0XA5K2oB7sJxnfyfq/94rs5k6xn0mr5suk8iS6TC5nIi19jmEqhg3Y4e6EQG9Nv9YNCKLgsiFyajUfciDiENJXjS9TCzpeROFzCrvKK6deLopk69R/676G/PuB3F0ukbHXpCXOgaboGQtzxPeyb7iunNO/Eea7Gy8TdUVFiv/m4b4FAMBh+rQCJFoUw7n0Q5xVxOnXrDjrWtfMwtOLXcYD2Xg4HcdxQ57ePt2z5v/NUBzOdhPp/91CZGmZVteXT6p5Bt0OQykSxljPtqOB6Oz9kYce3QMIOZw0ytuhYuqAAS0TbF0FKY/trp3hJm4l+s3/C48EVR0RIS+OjQqzaXwnm79lCWQCoDrev9wAAZF2iTSK0yNKHtZh3rG2+dV0jg65aYs4FKMD2LXmkF8eHd7PaU0u4wlPxD02pXHYSPNHIalGnfqfgexCK+P54yFoksbCBe3+1SCHjnddPwchziuEpzFfju5N379AKJVw+9F+PccIXvR+st6IpNJA+ZZxEcTLsp+DXm3aD7GtP9OHuwXfAfr+Ijcs8DS3fpWKHoNM0ydP3Yz+ZMRnl6Wn57eyub5ivLlWAu -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Environments LIST

- - - - - -**Required Permissions**: `Environment List` or `Environment Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all created environments. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    environments object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/event-summary-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/event-summary-get.api.mdx deleted file mode 100644 index 64936838..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/event-summary-get.api.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: event-summary-get -title: "Event Summary GET" -description: "Retrieve a summary of experiment exposure and goal events grouped by date and team," -sidebar_label: "Event Summary GET" -hide_title: true -hide_table_of_contents: true -api: eJztVk1v20YQ/SuLObUuK8lOT7ypqBEYQZDAjnuRVGNEjqiNuB/ZHcpiBf33YJaUJVuO4aY59NCTlvs18968eastOE8BWTt7VUIOl2uyfNMYg6F9SwwZBIre2UgR8i1cjEbyU1IsgvZyCnL4sIIMCmeZLMsqel/rIt05/BxlyxZisSSDMvJBIrLuLmRCkwaaqRs8Xi9c7ULa2HqCHCIHbSvYZaCtZo11fHbRoqHnT5VH07YxcwqQwcIFgww5lK6Z1wS7neD+0uhAJeSTPoujmH2EdN8s29/n5p+pYAnTT2AI2Mo3Ca0v4ewOPE04A7KNkQxo411sgoSsHNYwkyCE5u6VgKRATVeeV+wtkel7eEr7D4ntg/YXnhCVAWuu6Ynsrt39J9l2QuPTYEk6D9yelmEnJ357TrFXdo21LpWkpQLair5fwW51xNTcuZrQHgq3wDrSLAPb1DUKZXmaEUmE4MJjSZyo9UX8Ttquv+UZarEstQDA+uNRvin6gfc/hYaE81Iuuu57fc/dxcUpd4cjaoG6pvJ/6k6okxZ6RNo1cdC0JoUqdipXbqFo4yloQ5bVvr8V2lJJh6tO1qoKrvFUqnnbqVXWRfnZ1C5cUKgqvSarWJteyQP1HjfaNKb7VDqq89FIldjGgXQcVlEouHzomkhFEzS3kE9mGXgMaIhJ+J08rf2t1ZsUKjIar34y8WclWfCSVGQMLKjko8/kD1pgU3NU7NSbLgeFlRskK4UcvjQU2r2Z5rAIzsBxpXrKD/p5MCBt+c0FPJROW6aKghT6n+RMtnwhY+vuv5Upu3+b5ywDQ7x08uhW6aH1yEvIYbg+H3a1H/ZSAalRWO9L0oQaclgy+5gPhxFtOXebAc6jwcB1Oyicgd1RXW8kq67hbiOFsdfvqD3qGewmeqBLwjJ5/WMWx0rOqvHHK/WO2kSgjLHhpQv679QHA3V29r6JrOaktE2sdjyoKYy9/lUOtq4Jd02kcIde362oncLZ2YHX8fF90DMqC3/1F0yncTq9+SV1tLYLl3D0HTnHYkVW/Ei46vI+H4wGo1M0Vn3wZAXBjadCL3rHUrxEVt3eOcUEYfx7T2wCLMDvXVhpW6l7zcsE6KiRo/LBVQGNQdYF1nU76P0RC/HHXQa1LkiMIt/uUYvLBE0stRZg3kU2aI92pG5V/QOp3l5+egppe/Dg/5LZdApj2vDQ16itOHPS77aX+wTW54c3PIO95GcZLF1k2bDdzjHSbah3O5nuOjF5k47yLhz675uM/EDfehbSShpqb19rrBvZAsmLfkiOr/KpFzJLdnXIayYfQXeP6kT+SvZdL6x2J8ZFQZ6PTp28648cTBS5230F1WU7Kg== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Event Summary GET

- - - - - -Retrieve a summary of experiment exposure and goal events grouped by date and team, -for a given time range. Maximum range is 100 days. - -## Request - -

Query Parameters

- -Ok - -
Schema
    teams object[]required
  • Array [
  • ]
  • events object[]required
  • Array [
  • ]
- -Invalid date range - -
Schema
- -Validation failed - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/events-quota-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/events-quota-get.api.mdx deleted file mode 100644 index 3e6adb68..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/events-quota-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: events-quota-get -title: "Monthly Events Quota GET" -description: "Monthly Events Quota GET" -sidebar_label: "Monthly Events Quota GET" -hide_title: true -hide_table_of_contents: true -api: eJyVVMFu2zAM/RWBx8xL0h1984CiKIqiHbqekqygFTZWY0uqRKf1Av/7QMkt0g3YMF8sS+Tje+STj+A8BWTj7OUWSjg/kOX4rXeMF8RQQKDonY0UoTzCl+VSXluKOhgvSVDCzR4K0M4yWZZT9L41OkEunqKEHCHqhjqUlQ9SkE0G7Jzlph0qzeZA99ZMpa9N2xpnUwgPnqAE23c1BSjg0YUOGUrYur5uCcbiDeWE+38BjKLyuTeBtlCu/snpr/U2xVs9Vz+RZhjlKYBxFwU850hYJN0HwwOUq00BHgN2xBRi/v7Y4utcUOVslUqqi/PvwoW4cTK5XRqXR26ghMXhbEEpePEswSD1wiHDH6EPLZTQMPtYLhYR7bZ2r3OsY4eB22GuXQfjCcc7GV+e2H2kUHlzRcNJbzFvFGCEbUO4TZ3+KKJSkquq20t1RYN6dHmNPTcumJ/JMHM1m133kVVNyljFDak8LrWGypvPkji4Pjz0kcIDevOwp2ENsxkUYLETLtUpnuhO3KGEHxPAeh3X67tPae7GPrqkw3ArMTXqPdktFCC9yrzP5sv58k81Vt14sqLgzpM2j5PlFTfIKsfWFJOE6uvU2CRYhL+4sDd2p14MN0mQoldPwXRpvj64XcCuQzYa23aYTxcMtVywsYDWaLKRhPmk+jY4HwwxhiEJ8y5yh/Yk4i8e+qDsfahMr7zwLRordyxZ5jj5awWHMyggOwwKyB7bFNC4yHJ8PNYY6T604yjbzz2FyegHDAbl2pWrzVi8eUVMuRdLQaU1eXHyAds+e+u334kY8931ImAcfwHO2alq -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Monthly Events Quota GET

- - - - - -Monthly Events Quota GET - -## Request - -
- -Ok - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-activity-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-activity-get.api.mdx deleted file mode 100644 index a8b7282d..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-activity-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: experiment-activity-get -title: "Experiment Activity GET" -description: "**Required Permissions**: `Experiment Get` or `Experiment Admin`" -sidebar_label: "Experiment Activity GET" -hide_title: true -hide_table_of_contents: true -api: eJztXW1z2za2/iscfunWVxs7cWa662/uzra3d6dNpk7vl8iXgckjCwkJsABox/Xov98BSImkRJESJVkveXZmp44IHLzwOQcH543PfkQ6VDw1XAr/yj87+53+zLiiyHtPKuFacyn02dmV9+nfX1NSPCFhvJ/JfPKkqv12HSVcfPIHfsoUS8iQ0v7Vx2dfsIT8K59mLX+J/IHP7WApM2N/4KtiRP/KqIwGvg7HlDD/6tk3T6nty4Whe1L+ZDKY0ZOjkSYzpfRnRuqpRmrEYt1O69Y216kUmrRt8Obiwv6nvh/X3v/cvPvNe3f3mULjhVIYxgUX9x7zUqYMD7OYKa9c3HfaY6HhD9w8vfIHvu1Awli6LE1jHjJL9/yztsSfF2cn3Th2E5VMSRmeT62kHwhp8t+KHkwpZlfODSW6mxKPmvbC7kQaPwVG2qcii2N2F9P0fdBXlqT2n/bBoHUAP+TKbcnfvvcHvuHGdvNLlPwmDVWHc8sJGic1aJ/HZFDZlZ7rrpB8PRkUyJq10kZxcV9t5BvSJqgMO3H7rlgOlgb6CRc8yZKcvjbMdAygMmHRZQlH9ECxTN1LZ6ap20iqxD7xI2bo74YntLBp+ahqUwoy7U9g8b2NsjgOpChIzrdeYYgKjQemOBNthBpexsXAT9jX/O/LycCPmTaBJhIBF0EoI9pou4Sazko3Y2I2dBUflW2yU0pJhSQMu68x+2wmKTOGlBVQw2H0/GYyHJ7P/VGD1eXb88vL88vLpumWIwVyFBjFRiMedjDLxYWFBVHUukt3/J7nTFJQDdboEipihqLV30Slz91Tt0BgKhzzh9p07qSMiYnqSt0pMhn47IEZppqoLuxn3jQY8ZiCLI0li4JMxe1sfx4qmf6h4vPXFxdfX19cnL9+leZSYLNtCDJNapl4rcmmiOxxNidLG2b6K1NfyBQiihLGG1c2m1feYjIpz4I/dH7g9JlklkbrbUbD65nSAEYOHyPlu1pxkg1bXVPn2mb9Ycx1XZGrdrWzEdwEef++Wla3hjFd53ozJ49H2pMjT2bKsyT0TnGxwIr9zvDm19txjEPMHxULr7P/1e6Cmw+2eZXvlq2wpsSniidMPQUJGVXTY9Zk1XvJ4s4Bf7hYiak/8IQ8I70fpfyyNmezRGbCWOa2L967o5FU5DHvTsov9iI6Ztq7IxJewiK3X3MiqoGsW5ulZm9gLBxzeqDpfYZGI7tNTf2FRdFHP5WaG/7gTle6Z8Wfmfgi5KPwb9d86VMUBdqo9lk/T5xU0yGLaRUcUMh1fYdFltzVW9r398DijAItMxVSUIDjqX0q/mQGoycrAgx1zH3HPF5b+T5Fs0XWLo/HNFPhmGlai4uuPTstbySVZxQLc66Rj17CxJM3pag9psjxkCeFZ58Ux2nFbrOFUxUn1qGfWP00IFxGThoXre+uddKL273WezTsfgNr73IlZiarS4vtz5LF1mqbawfsvrWjbdBf0Nc7N8l5/RSOZSzvecjiqw8q0zAKnTqP7e32CVwcNC62KHut5GoRp3VZaP//gd1/X5tR8ePCb7XfiSUvLbTtmEs72Yf9hTV9ta6G2Zy6LwHdanwNGBDqJ8y8UKiBix0L9dze3VvctmNSU+M7B5IOBkmTlQ6/8sT8QCz53p+jYn90pEsHUCukqqEnJekyzuV7v0pqzbl1LWghqmY2+7X0m9lG5KbyDVgoJ7B0wlNTfDn8r+6XFfWWlleX0ymWX/l9tiE1tW36o3wUG0mM1oszJMkxS5KWw2AOTe8siNyvneyziPt5Yv7Glp7elpZY5rbtq/8mFtUVttPyGy+KjeK6tqk46JB+0C+OXCosAKdk/Q1v+rs9N3HfB7fgvg9cHAQucN8HknDff+H7/hY8DX2VCITyQE7sXU5AEwEuEMqDUB7w2LHIXoTynDQuTi2UZ4lDDQ4mwP8AHUwb3ZprHtS1Z1SQa3PRLvPl5r/7C6ldnbkwb2xyD8siTiJsvItWk+ifh36exzP0r56ZiK6Gw4+3k4lfIWEzlHgtNaqFc8ZPqTRj0rwhfT/PTop42HzftUO6R0Eqed0uUbbgdjiLW3ebDSIyjMfNTe08GtKTJjNWsL0pNJadg4X0r8b0/4114dpNvLecXMUqUxlpl9YMLvVahox3mfL4uxtrkoA2fPpiH5YI4KK/Ntztgl3vPa5k9G4SqNelMK2f5pUHfm2ApUivyOWV2jyQ0suqLC2Uj2m0mtfm6PJ+F4r0rHn+hFKMeIf5Y5XtWLsO1e8UeT9mxuS7XamBtBze9ZpHjRv0vwWdiSvuE0oRldrWjk/pFQCDhP7lZJHQj4R+JPTDCwgdC7o3cAEvILyA4LH98xi8gMDFt+AF3InQRoA/mPcQmRcKNXCBAH8gCQH+q88NCf1I6Ick+ebirZDQv1PnBBL6IRV6SQUk9OO+D27BfR+4wH0fSNo7knDfR0I/QnkgJ6CJABd71kQQyoNQHvAYQnmAi280lAcJ/YD/8TiYjj2hv9Vc3nhRvpmmpU2J5IlBD5we95+hRuKBKylcm/zp8yzHKqIHimXqxnDDR1me/n87/cJtaLPCGgG+kN448EdcaRPQ11TqTNFGZ23MtkUpYoYFYWbkaLSV078/jUbsvM9xUsVMsHkOKLIbkd2I7EZkN8IkCv3zeK7lMImeNC5gEoVJFDx2oLIXJtGTxsWpmUR3IrQR7QjmPUTmhUINXCDaEUhCtOPqc0N2I7IbIUm+Oeczsht36pxAdiOkQi+pgOxG3PfBLbjvAxe47wNJe0cS7vvIbkQoD+QENBHgYs+aCEJ5EMoDHkMoD3DxjYbyILsR8D8eB9NJZzdukC3Y+rm/8hN/J5NW6BKeKiuYpUWVzSnkSY6axIqGFdvmGxmuTDudzWTJQhZ7j2LJ3M7yJGVh2yZ09g1i+ZiLzN4UsjTtR6Htc5HVtMpOB9NWDVPwGOFQPJ67Auw0J40LeIyApKP1GDUdxTOy8NrAawNehTYAXMBrA68NeOxQeAxeG+ACXht4bQD/F/Ha9D27UZluoT8q06Ey3UqV6RoKZyDtbqc7j7Q7nLq9Tt1jTbvrka4+q72856iNLW0cFBsoNlBsXlaxgccHVscjPejh8QEu4PGBxwc8djyyFx6fk8bFqXl8diK0t3gzh+sJfHiACUMwjcM0DqlweFKhv2m8Oy+vTLfbZWnW/iVvunljSylRYITDZ4QOWbYIo5JRKgjoOue29TXL2og7PEC1YeGXqzsWfiER4Q5/+kyAOzxw0f8O3+1i6p3yVDm/52/1tUeL4nENmT5HyTq1pKE1Z/qbNOT0F0GPQWUqm5AasQepuN3wLSQggtsOmtu6VJEt6RDrb97cRH8qMFmO7JqwmNQmH23e8bLzX8pyHqFFdZYGgiiiyB/4LIs4iZCChOuEmXDsD3zt3nCg+V8UKGLh2LUsflXWxFC2vu0JzG14JBMyzH7pu4nCXONG+Xdt3517i5UVtwj23X53e1+7qOjPjCuKgrlNWBAS81VaqqEcF/98c/nWEXNw6T+hClH7oEayxwzbiTei4sa1uLFjlCVuAh0qEnost/OB9pViY9qq68wavnFRRoryydWOms4x3rriOHfUcSIV1VW8f32nPU2hFJHHDTk5IFYVVZV59ZeJORHN7qk/jeawHcd+Mk1X1QEUOeEoRRBRwsSqwWPlJqykGf3EY/rDNa9rgO53tw21TVkqWR55ZMYdWLj4hw0vGxO/H3cg7oc3F9NhlzDi9HF3iFShIH2WYxFEkmaajhSmWoxqOQGesHs6L7rdMU3LFKyZaLDPi9cdxDSqLralbJFrbmS6Ruv5Xe9qv7D3rR1glzhljXhVu0SxnRvekvC29+yTqCoZnVpG0xFbHNE3s/4NB0Z++LYWUCv7110P1TvPSrosC6eRrrOLh3sR/mCuoKA2TNn/Kpr+RRHPH8jU7l4Wx4G0OAxlUvQp4OriuKd/972GQCgeC5sg2BW42G3AlbVYrmBKaL+YLVKtmUV7XlzmbobdirWhvOZpRWyXd7bOV6gNa96KcgCVCVG8u4pE34jn3AmwIQWZbtP0UJw+G7l9pjQqoOnwG1RexsVcHV1XylYTiYCLIJQRbbRdQk1npZsxMRu6io/KNtkppaRCEobd16z9s5mkzNgSp/6VPxxGz28mw+H53B81WF2+Pb+8PL+8bJpuOVIgR4FRbDSqJc01XmvtXVVTTTgv7lJZdrigGqzRBWrHCR8vPScJFeTbwsiKKkdViC5s9RqJtlx75dn+nfaqXafV1udsZ1vPbpyuc90UYR7pabZibrY42ShViPljYuF19r/aXXDzwTav8t1K7p1U8YSppwDJ/8vJIvkfyf9I/kfyP04s2EOBCyT/I/kfPLZ/HkPiAHCB5P/dJf/3Fdb4mhqYFwo1cHGoQh1fU/umkbSHr6nVk1Pa0VEO7I7pvqF/zavoX7ZgLU1otmUvVbH35UodL3z2GXWQIHNQB6lp61AHCXWQIBVO8RMBsAyAW2AZAC4OAhewDABJsAwcrGVgC96LvuoGwoMgUfYuUaCzABcID0J4EHjsWGQvwoNOGhenFh6Er8ED/sfjinrBr8F2fytgwZnb9YHb+XSxzvwaV6RtWtyz6XVVE/Ofh36eGzT0r56ZiK6Gw4+3k4lfIWGznngt3aqFc8ZPqTRj0ryhJECe8RTxsPm+OyseFKSS1y0YZQtuh7O4dbfZICLDeNzc1M6jIeVpMmMF25tCY9k5WEgpaywpsLEuXLuJ95aT27XfVOa0S7sHl3otk8e7THn83Y01XkBvPv0DAjYL4GKX9fjXe4+9q/dfl8K0fu5XHqxoNK/I5ZXaPJDSy2o8LRSvaa6KXZ1jWe1qg5MqlGLEOwwlq2zH2lWwfqfI+zEzJt/ttrJdSyoutRVLzAuHu3rIpV52MOf5CtBC4YHlZFF4AIUHUHgAnkVoY9DSgQt4FuFZBI/tn8fgWQQuvgXP4k6ENtILwLyHyLxQqIELpBcASUgvOKr0AhQeQOEByJxDjfZC4YGdujFQeABSoZdUQOEBWAbALbAMABewDABJe0cSLAMoPIDwIEgU6CzAxdHoLAgPQngQeAzhQcDFNxoehMIDgP/xuKKOvfBAq2G98aJ8M02KmxLJk40eOD0eU34ciQeupHBt8qfPswyviB4olqmj5gaPsrygwe30O8ChzUlrZIWFNMyBP+JKm4C+plJnijY6lWO2LUoRMywIMyNHo63oCf1pNKLsfY6oKrqCzXNVkYWJLExkYSILE2ZW6LSHrdPCzApcwMwKMyt47FhkL8ysJ42LUzOz7kRoI9YSzHuIzAuFGrhArCWQhFjLo4q1RBYmsjAhcw7V9Y0szJ26MZCFCanQSyogCxOWAXALLAPABSwDQNLekQTLALIwER4EiQKdBbg4Gp0F4UEIDwKPITwIuPhGw4OQhQn4H48r6qSzMDfIVWz9KGL5IcSTSWp0SVSVFcxSrcrmFPIkR01iRcOKbfONDFemnc5msmQhi71HsWRuZ3mSsrBtEzr7BrF8zEVmbwpZmvaj0PZRzWpSZ6crak8mLHihcHwez60CFp2TxgW8UEDS0Xqhmr6dPiML/w78O+BVaAPABfw78O+Axw6Fx+DfAS7g34F/B/B/Ef9O37MbdfEW+qMuHurirVQXr6FsB1L5drrzSOXDqdvr1D3WVL4eKfCzatJ7ju/Y0sZBsYFiA8XmZRUbeHxgdTzSgx4eH+ACHh94fMBjxyN74fE5aVycmsdnJ0J7izdzuJ7AhweYWgTTOEzjkAqHJxX6m8a7M/jKxLxdlnvtXxynmzdePHkKLHP4LNMh9RbffclSFQR0nYgv/yXP2tx2eChrw8IvV3cs/EIigl3g9NkFdgHgor9doNtt1TuNqqITzFsKao8WxeMa0n+OknWUSUNrzvQ3acjpRIIeg8pUNiE1Yg9ScbvhW0hqBLcdNLd1KS0vrm2sv81zS/qpQG91ZAuGmNQmn7Y+mA3KfykLlISWU7I0EEQRRf7AZ1nESYQUJFwnzIRjf+Brh5pA878oUMTCsWtZ/KqsKaRsfdsT7NvwnCZkmP1yehOFucaNMvXavmX3visrbjksDuU75vvab0V/ZlxRFMxt14KImq9QUw1Oufjnm8u3jpgDVv8JVYjaBzWSPWbYTrwRPzeuxY0doyzvE+hQkdBjuYn86ALBXLRPW2WhWcM3Lm5KUT652kHXOcZbVxjojjrOw6KyjPev77SnKZQi8rghJzHE9sVfZQX9JXJORLN76k+jOWTJMapM01V1FUVO4EoRRJQwsWrgXLkJK2lwP/GY/nDN65qq+91tQ21TlsqgRx6ZcQdqLv5hQ+vGxO/HHdj84c3FdNglLDt93B0eVihyn+VYBJGkmUYmhamW7FpOgCfsns6LbndM0zJFcCZE7PPidQcxjaqLbSnu5Jobma7Ren7Xu9ov7H1rB9hPTllzX9V+Umznhrc5vO09+2Oq6kinPtJ0wy8O85tZ/4YDIz98W8vMlf3rbpfKWd7wlucMFKvacBSl8ZMNaJ8zbvSybTRO1j7L3T6jkaamY22S/89dT8YysqH25PiDWdHtn1fsTOfP5T9+iSbnLDT8gRs7PU3qwTHgx2d3vFz5Y2NSfXV+rpmI7uTXV+xOJ0yZ+OlVKBN/cmv7hJmy3W0nC4TrlP+H7D9vq49vwjElOZdWG5U7lP8w8Lmww+Y+77lQa//as3296/e/eP+hJxdXbf9mmRlLxf9yKt8r7+zs10wb7448LjwzJi9Hrjf0r1P+d9vxSWa5rAlYyoMv9DT0z878qU7lX1fp2W1xc/ev/P8rCAyHeji8+S/3SrgYSbeO4q1NnQMD325lPu/Xry5eXSyuRnjvUhJ2BTcphXxUBHt7ZsyMl7e9I+2WcP1jse9uwXbhj1K5ePJHbsZuQV7lHXupkveKJQkzNo4xfnrl58pIXlbSKtY8JKHzi2e+6vdKpoqTYerJLSyV2iR5fcyiRQlI77oAjffzvz/ML+x5qvb4V/7Z2e/F/c17Tyrh2u6IPju78j5VqP1M5pMnVe236yjh4pM/YzhDX815GjPulPpC+ubw/lgzow78qyrArblhivDbgT+W2tgez89WyfpDxZOJ/fnPjFQO4Yhry+5RcU4M/C8Wp1POmxUY9R34nbxzwqGp59Jd+dt0U773li1wyhbiqTrmdDa1BU5uncLrOMbOI29yHYaUVidcSSc4/6zt3ei2Ii7se5xM/h+QRocw -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Activity GET

- - - - - -**Required Permissions**: `Experiment Get` or `Experiment Admin` - -## Request - -

Path Parameters

Query Parameters

- -A JSON Object containing a particular experiment's activity. - -
Schema
    experiment_notes object[]
  • Array [
  • reply_to objectnullable
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • experiment object
    application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • experiment object
  • ]
  • preview_variants object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment object
  • ]
  • alerts object[]
  • Array [
  • experiment object
  • ]
  • sample_size objectnullable
    experiment object
    variant_screnshots object[]
  • Array [
  • experiment object
    file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-annotation-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-annotation-get.api.mdx deleted file mode 100644 index 17878991..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-annotation-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: experiment-annotation-get -title: "Experiment Annotation GET" -description: "**Required Permissions**: `Annotation Get` or `Annotation Admin`" -sidebar_label: "Experiment Annotation GET" -hide_title: true -hide_table_of_contents: true -api: eJztVktz20YM/is7yKGtSktyD51WNzVjZ9JMak8cnyxHBklIXHtf2QVtqxr+984uKZuypCSHdKaH6iJyidf3AVhgDSWFwkvH0hqYwGDwgT7X0lMpzslrGYK0JgwGE3EzNcYyRjnxhvhGWL91Ni21NDeQgUOPmph8gMnVGgxqggnQoyMvNRl+1nlbQgYyunXIFWTgO98wYV9TBqGoSCNM1sArF61Iw7QkD032Iu6PFQlZCrsQXJE4eXImehFyhSxWthYPMlSCrVgSixIZxcJbPYTmOkYQnDWBQnT6y3gc/7Y9TcWfF2d/ibP8lgoWhTWM0kizFGjEM0iBT35/CMnJEDKI0mQ4GkXnlCySwOg2RMvrXbg2OYmceuvIs2zjenYzf3bzdTVZ7meSpabAqF3vc2AvzRIyWFivkWECJTIdRdEd8neV6BG1U5TyIoN4wCBu68ACF0xeoAh1UVAIi1oJjf6OOPJXoHYolybaL6yyfp9lh8zkYx4+vbqaHp3i0WJ89Pv1+tdmy+2r16evfzs9TeiShTWQqTVMrkDZAhVksFQ2RwXXTdbn8xBHhSdkKufI307SRidfzetA/qDt2pU926ZWCvOIou2Bb/O1sbHt64CtPbjy1dfrB31RyXvqo8itVYSmz/0CVaAmA7xHRr/P6nZUT6LzhVQ0r52yWM5rr75cWKPCW3fp1eh4PH48Ho9Hx0Nnlv9qqjLQ0kgdy+g49YBDz7rr58ORvt9UeHREGuVeZE9xtRJN6ktOBi7Ddp38n6v/eK52aOsJnOyZg9C0vww0cWVLmMCSuL3tqsjf3gs/jNb7h2q8CgP5+80ETvmBitmFyWgU0JS5fRxiHjR6VqthYXWafYGK2kteJaUIZOrkO4qv1/3PF3FKtVXWF3qiCduDbrJXhGWi5OUUjbpiev5WvKOVWNj2GWuurJd/JyRDMRi8j2MjJyFNGuwt82IGUyePouLK1r4tA3RyfkerGQwGMQHt1jHt24NuoYgfPnUGZrMwm138nHIozcImHF2qcizuyMQdJVLZxn08HA/Hu2iMOHNkIoILR4VcdJO9XTla2ZxCgjD9o+M9AY7AH6y/iwPwQXKVAPX2iCCct0uPWiPLApVabfYILGItNxkoWZAJacZ1qM+9dV4So18lYM4G1mh6EvsXpDcnH19CWz/vLN9jN+xKhOmRR06hTMO+uz/aYr/av90EyGByYIe8zqCygaPuep1joEuvmiYef67Jp/rN4B69bDvyag2lDPG57G7AL2D+cQP5J/E9VswDDGw6x8S2uUdVxzfI4C421qHVuYmrS9deEVQrPC0Kctwzs7Noxl5+umdiypvmH9vPLrI= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Annotation GET

- - - - - -**Required Permissions**: `Annotation Get` or `Annotation Admin` - -## Request - -

Path Parameters

- -A JSON Object containing an experiment annotation's data. - -
Schema
    experiment_annotation object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-annotations-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-annotations-list.api.mdx deleted file mode 100644 index b01d1918..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-annotations-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: experiment-annotations-list -title: "Experiment Annotations LIST" -description: "**Required Permissions**: `Annotation List` or `Annotation Admin`" -sidebar_label: "Experiment Annotations LIST" -hide_title: true -hide_table_of_contents: true -api: eJztV9tu4zYQ/RWC++YqtlOgRes3d7EptrvbBJvkKfY6I2lsMeZtyVES1dC/F6TkWL5uWrRAH+oX29LwzOUMh4crnqPPnLAkjOYj3ut9xq+lcJizK3RKeC+M9r3eiN2PtTYEwY59FJ7umXFbD8e5EvqeJ9yCA4WEzvPR3YprUMhH3BtHPOEiePlaoqt4suP7pkBm0gfMiC2xYmRYWMOoQObQl5I8S6s+T7jPClTARytOlY3Y5IRe8ITjMygrw6Pota6TLf8z8NluDHtgqTESQXfRyJXYxbKwwG/iCE24QNfFOe+CCELl/w7KD10UfLbohEJNM5HvormWSz6ag/R4Ar7eJeNCSELHNvAMXqgOPLD7Lc/3vJ4Gf94a7dEHD98Ph+FrG3bMfru+/J1dNjRnRhMILfSCgWbgHFTMzBlIecRxYD8sQk0BG6yVIouvBg8+OFjtp9i0VOhLZyw6Ek14TfkPViLSe4gCJbRQpQpEJpwMgTwM0ClNJ/iObUw1sLUTxLFY88N+SCj0BMoe2gtz4xQQH/EcCM+C6R7LpzbQTSE8ewLPHkpPDOahG4D5MsvQ+3kpmQK3RArcZaAsiIUO+JmRxh1CtkCELvTAlzd347MLOJsPz36ern6st9y+eXvx9qeLi5hdRFhx1KHkd1yaDCRP+EKaFCSfbhf6WI0yh0CYz4BeX6T1mrSalR7dUezS5h1sXUoJ6XpeJK/0tcbY9nUE60BeafXt/gGXFeIR89NTLs6IOuHwCATuEOp2VC+ms7mQOCutNJDPSidPN9Ygc8beOjk4Hw6fz4fDwXnf6sW/StXOzs3RgiPVDpHjkX5ad3jc0wrEwcxe4mos6rgvKQLc+u0++Z+r/zhXe2XrGLx7mTUb0cPr9pNwhVSYnI/4AqkZd0Uo4JGjIOEe3eNaIkUeeEFk/Wgw8KDz1Dz3IfUKHMmqnxkVz1ePWekEVXFRCHhsxQcMf6fd19fhCGy6qWu0OX2aB61YKBDymPruSR3WsvHVe/YBKzY3zW8oqTBO/BHz6LNe71M4HlJkQkel1lSYTfjYirOwsDKla+gGK2ZLrCa81wuFbvTLuIu3FkDhxZcWYDLxk8n1d5Eroecm5tFSkkK2RB1kTyhlE/d5f9gf7mej2aVFHTK4tpiJeSsbGBVArLFN0ccUxr+0dY8Jh8SfjFuGg+5JUBET6sgTz6wzCwdKAYkMpKzWIgWy0LN1wqXIUPt4lrVZXzljnUACV8XErPGkQHcsNt3Gxh3h9fH99c1ucquNJPpH9HvbJYTPNLASRDzX21HRtPXdMYUzTXhhPAWL1SoFj7dO1nV43EjS0Le58GGDbUTp0WRefSE4GPEy9Pz62vEIsgwmPEjnvQg2pu0N4TXm7SXgNaZrqX/a9mgd/rIWP1mR3RvDJqhp+ONEM/7ugr5qZ0OgrVk8zjK03YLuSfCA8jILf313w+v6T0y5+Ms= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Annotations LIST

- - - - - -**Required Permissions**: `Annotation List` or `Annotation Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all experiment annotations. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment_annotations object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-archive.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-archive.api.mdx deleted file mode 100644 index 5674ff6f..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-archive.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: experiment-archive -title: "Experiment ARCHIVE" -description: "**Required Permissions**: `Experiment Archive` or `Experiment Admin`" -sidebar_label: "Experiment ARCHIVE" -hide_title: true -hide_table_of_contents: true -api: eJztXW1z2za2/iscfuk2Vxs7ceZ219+czvZu7842mTrdL5EvA5NHFhqRYAHQjuvRf78DkBJBiSIpSrJe/HRmt66INx485+DgvPHJj0iFkqeai8S/9F+9+pX+yLikyPtIMuZKcZGoV68uvS//+JaS5DEl2ruS4Zjf0xdPyOrvUcyTL/7AT5lkMWmSyr/8/OQnLCb/0qd5y58jf+BzM2HK9Ngf+LKY1b/UMqPBwqo+jcn7wqMvnhh5ekxeOZD3MObh2HsUmffAEu1p4bF8ca/9ga/CMcXMv3zy9WNqVsATTXck/YE/EjJmOv/pv9/5Az/mCY+z2L98M53e5Asipd+L6NH0X14PC81/mAk1+0qe+bOyssHiSnnksSTymBeK2P6ghXcnPDYRyZ33wPXYdsiHfV1DklAkmhJtVsPSdMJDZlqe/a7Mkp6W31Xc/k6hNpshRUpSc1K2b04ep+GtEBNiiT/w6RuL0wnlM04HPo/q373PXqyzA85K3lxMB34iNNWvRBJTIvEexo92XiapmJMnd54ec+Wsz1mF0pInd+4b+1fzbs4bMeVx7XHlJcIz+0TSS4giivyp/cfskkpFonLavj0/X17mlfe/1x9+8T7Y7cg32pkhYpotQcW8bw6WxGNSskdDbJJSSGVeYktIyAd02tmpDGNqit3fC2qZ1y0X2T5+jp6lfS+31uyslQyLM7n7oknpwJl2atcnWU7dmvEdRh74SjPdMoHMksS+npE69zQRqZknYLqu2xy0EdP0V81j8gd+kk0m7NbhG6WZ3HQEkfYfwHk982A68EfZZBKIpBhysXWHKZwx7pnkLGkaqGYzzgd+zL7lfxuWnjClA0WUBDwJQhHRRuRK5GxVqh4T86lXiBmzpJRkSIlmd1QDfnOmaU3ScPRwGD29nQ6HZwt/VGB18e7s4uLs4qJuueVMgRgFWrLRiIctzHJ+bmBBFDVS6Zbf8ZxJilGDNbqEkpimqPtOOH1uHzsfPVHz2TNiE2WIxO6ZZrJu1CV65k2DEZ9QkKUTwaIgk5Nmtj8LpUh/k5OzN+fn396cn5+9eZ3mUmAzMgSZIhmskH0V2RRRyqRekKU1K/03k19JFyKKYsZr32y+rryFEdaaazvAb4pk30VmabQeMWq2ZzYGMHL4GCn3quMia0hd0X+aVv2pqqB9pzy3q1lNwnWQ9++lbXTSMGbvud7KyeORMnqZyKRnhlA7xcUSK/Y7w+u3t+UYh5g/KhZeh/5u94TrT6a5y3er3rCixKeSx0w+BjFpWdFj1mTVO8EmrRP+cN6JqT/xmMwN9L0QX9fmbBaLLNH2hmuGuaWRMBdL71aIr+aGOGbKuyVKvJhFll4LIqpmWPtuZrRAi4CFY073NLvP0GhkyFTXPzEo+uynQnFtbu0DP6E7VvyZJV8T8ZD4N2tu+gxFgdKyedVPUyvVVMgm1AUHFHJVpXCSxbfVlmb/7tkko0CJTIYUFOB4bF6KP53D6NGIAE0ta98xj1fefJ+i2SBrl8djmslwzBStxUVXnlmWNxLS05KFOdeIBy9myaM3G1FZe43hIWM+M0+K49SxamzhVMWJdegnVj8NCJeRk8ZF4941LnqZ3Gvto2Z3XayiKzCzWomZy2o/5DLMJkz+5X8Em3zvF5qPZneNHU2D/oK+2rlOzqvHcCwm4o6HbHL5SWYKRqFT57G93T6Bi4PGxRZlr5FcDeK0KgvN/z6xu+8rKyp+XPqt8jux+LmFtplzZSfzsL+wpm/G1TBfU/sloF2NrwADQv2EmRcKNXCxY6Ge27t7i9tmTCqq3XMg6WCQNO10+JUn5idi8ff+wijmx4WYkkZIuaEn5dBl9Nn3vjvUmmtre6Fi3eVs89Wvpd/MCZGbyjdgoXyAlQuemeLL6f9tf+motzRsXT5O8frO73OCVNS22Y/iIdlIYjRenCFJjlmSNBwGC2j6YEBkf21ln2XcLw7mb2zp6W1pmYjctn35T2JRVWE7Lb/xstgormubioMW6Qf94silwhJwStbf8Ka/23MT931wC+77wMVB4AL3fSAJ9/1nvu9vwdPQV4lAKA/kxN7lBDQR4AKhPAjlAY8di+xFKM9J4+LUQnlWONTgYAL8D9DBtNGtueJBXXtFxXBNLtpVvtz8d38ptas1F+atSe5hWcQpCWvvom4S/dPQz/N4hv7lE0uiy+Hw88106jtDmAwlXkmNauCc8WMq9JgUr6tdYbOTIh7W33fNlPZRkApetUuULbiZzuDW3maDiDTjk/qmZh016UnTOSuY3hRqw87BUvpXbfr/xrpw5SbeW052sco4M+3SmsGFWsuQ8SGTHv9wbUwS0IZPX+zDEgFc9NeG212w6+1jJ6N3nUC9KoVp9TR3HviVCVYi3ZHLndrck1SrqiwtlY+ptZpX1mjzfpeK9Kx5/oQiGfEW80cXcqxdh+pXirz3mdY5tZ0aSKvhXa15VEug/xTjTG1xn1AkUalt7fiU7gAYJPSvHhYJ/UjoR0I/vIDQsaB7AxfwAsILCB7bP4/BCwhcvAQv4E6ENgL8wbyHyLxQqIELBPgDSQjw7742JPQjoR+S5MXFWyGhf6fOCST0Qyr0kgpI6Md9H9yC+z5wgfs+kLR3JOG+j4R+hPJATkATAS72rIkglAehPOAxhPIAFy80lAcJ/YD/8TiYjj2hv9FcXntRvp6lpc0GyROD7jk97D9DjZJ7LkVi2+RPn+Y5VhHd00Skdg47fZTl6f83sy/chiYrrBbgS+mNA3/EpdIBfUuFyiRtdNZO2LZGiphmQZhpMRpt5fTvP0Ytdj7mOHExE2yeA4rsRmQ3IrsR2Y0wiUL/PJ5rOUyiJ40LmERhEgWPHajshUn0pHFxaibRnQhtRDuCeQ+ReaFQAxeIdgSSEO3YfW3IbkR2IyTJi3M+I7txp84JZDdCKvSSCshuxH0f3IL7PnCB+z6QtHck4b6P7EaE8kBOQBMBLvasiSCUB6E84DGE8gAXLzSUB9mNgP/xOJhOOrtxg2zBxs/9lZ/4O5m0Qpvw5LzBPC2qbE4hj3PUxEY0dGybEzLsPHY6X8mKF1nuPZoIZinL45SFTURo7RtMxEMuMnuPkKVpvxGaPhfpplW2Opi2apiCxwiH4vHcFWCnOWlcwGMEJB2tx6juKJ4PC68NvDbgVWgDwAW8NvDagMcOhcfgtQEu4LWB1wbwfxavTd+zG5XplvqjMh0q03WqTFdTOANpdzulPNLucOr2OnWPNe2uR7r6vPbynqM2tkQ4KDZQbKDYPK9iA48PrI5HetDD4wNcwOMDjw947HhkLzw+J42LU/P47ERob/FmDtcT+PAAE4ZgGodpHFLh8KRCf9N4e15emW63y9Ks/UvetPPGllKiwAiHzwgtsmwZRiWjOAhoO+e29TXLyow7PECVZuHXy1sWfqUkwh3+9JkAd3jgov8dvt3F1DvlyTm/F2/1lUfL4nENmb4wknFqCU07uLlISiePgRZ1RJvvnnkwaJygJJS1Iiy9zy9CkztdYF6nm71lYR0Vqm50drFw5vObuaRzBvAHC6UVlGbS/FvS7C+KeP5ApAa12WQSCMP/oYiLPoWYsB7t2d83OLZOWzzB7Qdc7Nj0bORm3RKWGjYVgFkelR4CV6o2o6lN2LfP0PmUnp8XTt8FEnQ4ss3ps+qkzk+m5RXivMV5C7l62HIV5y1wgfP2SM/bEbsXkps92UIpGzDkQTNkm1F7SxrG+sRbWOhPBSYd3jJN2IRk87cU+imD2yp0Z39x1CqD6iwNEqKIIqMcZRGnJKQg5ipmOhwbXcrucKD4nxRIYuHYtix+lcZZXbbuq0ht49CNSbOIadZBCNfKmyuzd3YXnTduEIYrtnBvCN0OFSX9kXFJUbBAhCUhsVjv000KOP/724t3djALl/4LWr5ilEP2WGHz4LWouLYtrs0c5dkdqFBSosZiE15vA8FClkWT2jBv+Nbmq0jKF1c5alrneGfLrN5Sy4lU1On0fvxOeYpCkUQe12TlQNJVVDnr6i8T80EUu6P+Y9QngFj2E2naVQeQZIWjSIKIYpZ0TUMqidDJsfATn9BvtnlVY7K/WzJUiLJSsjzwSI9bsHD+N5OoNCZ+N25B3A9vz2fTrmDE2eP2ZJtCQfpdjJMgEjTXdESi3bLGqwfgMbujs6LbLVO0SsGaiwbzvNjuYEIj92UbCuDa5sbE0L31ItXb2i/RvrEDTBenrBF3NV0U5NzwloTd3nN0m6tktGoZdUdscURfz/vXHBj54dtYirvsXw1ic+88FV124f7/wgzevd57QclrPyM15YXwnR0o1a9WMCvN6q1U5QQyS5ICxY6xfaM7hTXObziCSLd5iygcAxvFAs3GcBTzFrOZsxnnCx9XsN83UERJwJMgFBFtRK5Ezlal6jExn9rFh0Mms6SUZEiJZncV79Z8JSnTpu69f+kPh9HT2+lweLbwRwVWF+/OLi7OLi7qllvOFIhRoCUbjSqVFGo1VKN2KqocU8tUKr9FUYwarNEFatUpH7T9Fgnv0MvCSEdvkCtEl0i9RvUVrrzybP9OeW7X2Sd4Fq7BWy95MXvPdevG8EjNSljkN5CTTV2CmD8mFl6H/m73hOtPprnLd50stankMZOPASpCrR4WFaFQEWo3ohkVoXAxOfITC6FqwAUqQqEiFHjsWGQvsklPGheoCLWdilB9hTU+sQvmhUINXByqUMcndl80kvbwid2txZnXr61/haq19Js5IZ7r4wzP91WLOUFQ8hKSZEvpTyh5edx+Y5S8hFToJRWO9WtQuO+DW3DfBy4OAhe47wNJuO8/831/C56GvkoEQnkgJ/YuJ6CJABcI5UEoD3jsWGQvQnlOGhenFsqzwqEGBxPgf4AOpu19NHDtFS1/7GnJRbvKl1t+Faqa2tWaC2NrI81q6tVtl5tE/zT08zyeoX/5xJLocjj8fDOd+s4QJkOJV1KjGjhn/JgKPSbFa9L38+ykiIf19915DeYgFbxqlyhbcDOdwa29zQYRacYn9U3NOmrSk6ZzVjC9KdSGnYOl9K/a9P+NdeHKTby3nOxilXFm2qU1gwu1liHjQyY9/uHamCSgDZ++2IclArjY5WeS1tvH3h9VuiqFafU0dx741bJUK8ullT06tbknqVZVWVoqH1NfYtZdY1npa4PzJxTJiLeYP7qQY+06VL9S5L3PtM6p3VScdEXNo6bKY3kVXltctNS2dnxKdwAMEvpXD4uEfiT0I6EfXkDoWNC9gQt4AeEFBI/tn8fgBQQuXoIXcCdCGwH+YN5DZF4o1MAFAvyBJAT4d18bEvqR0A9J8uLirZDQv1PnBBL6IRV6SQUk9OO+D27BfR+4wH0fSNo7knDfR0I/QnkgJ6CJABd71kQQyoNQHvAYQnmAixcayoOEfsD/eBxMx57Q32gur70oX8/S0maD5IlB95we9p+hRsk9lyKxbfKnT/Mcq4juaSJSO4edPsry9P+b2RduQ5MVVgvwpfTGgT/iUumAvqVCZZI2OmsnbFsjRUyzIMy0GI22cvr3H6MWOx9znLiYCTbPAUV2I7Ibkd2I7EaYRKF/Hs+1HCbRk8YFTKIwiYLHDlT2wiR60rg4NZPoToQ2oh3BvIfIvFCogQtEOwJJiHbsvjZkNyK7EZLkxTmfkd24U+cEshshFXpJBWQ34r4PbsF9H7jAfR9I2juScN9HdiNCeSAnoIkAF3vWRBDKg1Ae8BhCeYCLFxrKg+xGwP94HEwnnd24QbZg4+f+yk/8nUxaoU14ct5gnhZVNqeQxzlqYiMaOrbNCRl2Hjudr2TFiyz3Hk0Es5TlccrCJiK09g0m4iEXmb1HyNK03whNn4t00ypbHUxbNUzBY4RD8XjuCrDTnDQu4DECko7WY1R3FM+HhdcGXhvwKrQB4AJeG3htwGOHwmPw2gAX8NrAawP4P4vXpu/Zjcp0S/1RmQ6V6TpVpqspnIG0u51SHml3OHV7nbrHmnbXI119Xnt5z1EbWyIcFBsoNlBsnlexgccHVscjPejh8QEu4PGBxwc8djyyFx6fk8bFqXl8diK0t3gzh+sJfHiACUMwjcM0DqlweFKhv2m8PS+vTLfbZWnW/iVv2nljSylRYITDZ4QWWbYMo5JRHAS0nXPb+pplZcYdHqBKs/Dr5S0Lv1IS4Q5/+kyAOzxw0f8O3+5i6p3y5Jzfi7f6yqNl8biGTF8YyTi1hKY1V/qL0GT1l4QeAmcpmww1YvdCckPwLSQggtsOmtvaVJEt6RDrE29hoT8VmCxntk3YhOQmH23e8Wvnv5TlPEKD6iwNEqKIIn/gsyzilIQUxFzFTIdjf+Aru8OB4n9SIImFY9uy+FUaE0PZ+qYnMLfhkYxJM/Ol77oRFhrXyr8rs3d2F503bhDsu/3u9r6oKOmPjEuKggUiLAmJxSotbijH+d/fXryzg1m49F+QM6h5UBmyxwqbB69FxbVtcW3mKEvcBCqUlKix2M4H2jvFxjRV15k3fGujjCTli6scNa1zvLPFcW6p5UQqqqt4P36nPEWhSCKPa7JyIOkqqpx19ZeJ+SCK3VH/MerDdiz7iTTtqgNIssJRJEFEMUu6Bo+VROikGf3EJ/SbbV7VAO3vlgwVoqyULA880uMWLJz/zYSXjYnfjVsQ98Pb89m0Kxhx9rg9RKpQkH4X4ySIBM01HZFotxjV6gF4zO7orOh2yxStUrDmosE8L7Y7mNDIfdmGskW2uRbpGq0Xqd7Wfon2jR1glzhljbirXaIg54a3JOz2nn0SrpLRqmXUHbHFEX09719zYOSHb2MBtbJ/1fXg3nk66bIsnEW6zi8ediP8wUJBQaWZNP+WNPuLIp4/EKmhXjaZBMLgMBRx0aeAq43jnv3d9xoCoXgsbIJgV+BitwFXxmLZwZTQfDFbHrViFu15cVm4GbYr1prymqeO2C7vbK1bqDSrJ0U5gcySpNg7R6JvxHP2BNhwBJFu0/RQnD4buX1mYzigafEbOJtxvlBH15ayVURJwJMgFBFtRK5Ezlal6jExn9rFh0Mms6SUZEiJZncVa/98JSnTpsSpf+kPh9HT2+lweLbwRwVWF+/OLi7OLi7qllvOFIhRoCUbjSpJc7XXWnNXVVQRzstUKssOF6MGa3SB2nHCx0vPRUIFeVkY6ahyuEJ0idRrJNpy5ZVn+3fKc7vOqq0v2M62nt04e891U4R5pGbZirnZ4mSjVCHmj4mF16G/2z3h+pNp7vJdJ/dOKnnM5GOA5P/VwyL5H8n/SP5H8j9OLNhDgQsk/yP5Hzy2fx5D4gBwgeT/3SX/9xXW+JoamBcKNXBxqEIdX1N70Ujaw9fUqskpzegoJ7bHdN/Qv/q36F+2YC1NaE6y56rY+3yljpc++4w6SJA5qINURzrUQUIdJEiFU/xEACwD4BZYBoCLg8AFLANAEiwDB2sZ2IL3oq+6gfAgSJS9SxToLMAFwoMQHgQeOxbZi/Cgk8bFqYUH4WvwgP/xuKKe8Wuw7d8KWHLmtn3gdjFdrDW/xhZpmxX3rNsuNzH/aejnuUFD//KJJdHlcPj5Zjr1nSFM1hOvpFs1cM74MRV6TIrXlATIM54iHtbfd+fFg4JU8KoFo2zBzXQGt/Y2G0SkGZ/UNzXrqEl5ms5ZwfSmUBt2DpZSympLCmysC1du4r3l5HbtN86admn34EKtZfL4kEmPf7g2xgvozad/QMBmAVzssh7/evvYu3r/VSlMq+e+86Cj0dyRy53a3JNUq2o8LRWvqa+K7a6xrHa1wUkVimTEWwwlXcixdhWsXyny3mda59RuKtu1ouJSU7HEvHC4rYdc6mUHc553gBYKD6weFoUHUHgAhQfgWYQ2Bi0duIBnEZ5F8Nj+eQyeReDiJXgWdyK0kV4A5j1E5oVCDVwgvQBIQnrBUaUXoPAACg9A5hxqtBcKD+zUjYHCA5AKvaQCCg/AMgBugWUAuIBlAEjaO5JgGUDhAYQHQaJAZwEujkZnQXgQwoPAYwgPAi5eaHgQCg8A/sfjijr2wgONhvXai/L1LCluNkiebHTP6eGY8uMouedSJLZN/vRpnuEV0T1NRGpHs5NHWV7Q4Gb2HeDQ5KTVssJSGubAH3GpdEDfUqEySRudyhO2rZEiplkQZlqMRlvRE/qPUYuyjzmiXHQFm+eqIgsTWZjIwkQWJsys0GkPW6eFmRW4gJkVZlbw2LHIXphZTxoXp2Zm3YnQRqwlmPcQmRcKNXCBWEsgCbGWRxVriSxMZGFC5hyq6xtZmDt1YyALE1Khl1RAFiYsA+AWWAaAC1gGgKS9IwmWAWRhIjwIEgU6C3BxNDoLwoMQHgQeQ3gQcPFCw4OQhQn4H48r6qSzMDfIVWz8KGL5IcSTSWq0SVTOG8xTrcrmFPI4R01sREPHtjkhw85jp/OVrHiR5d6jiWCWsjxOWdhEhNa+wUQ85CKz9whZmvYboemjmm5SZ6srak8mLHihcHwez60CFp2TxgW8UEDS0Xqh6r6dPh8W/h34d8Cr0AaAC/h34N8Bjx0Kj8G/A1zAvwP/DuD/LP6dvmc36uIt9UddPNTF61QXr6ZsB1L5dkp5pPLh1O116h5rKl+PFPh5Nek9x3dsiXBQbKDYQLF5XsUGHh9YHY/0oIfHB7iAxwceH/DY8cheeHxOGhen5vHZidDe4s0crifw4QGmFsE0DtM4pMLhSYX+pvH2DL4yMW+X5V77F8dp541nT54Cyxw+y7RIveW9L1nKQUDbifj8X/KsrG2Hh7LSLPx6ecvCr5REsAucPrvALgBc9LcLtLuteqdROTrBoqWg8mhZPK4h/RdGMo4yoWnNlf4iNFmdKKGHwFnKJkON2L2Q3BB8C0mN4LaD5rY2peXZtY31ybzwSj8V6HVnNmCYkNzk09YHQ6D8l7JASWg4JUuDhCiiyB/4LIs4JSEFMVcx0+HYH/jKoiZQ/E8KJLFwbFsWv0pjCilb3/QE+zY8pzFpZr6cXjfCQuNamXpldtnut/PGDYfFoXzHfF/0lvRHxiVFwQK5lkTUYoUaNzjl/O9vL97ZwSyw+i/IGdQ8qAzZY4XNg9fi59q2uDZzlOV9AhVKStRYbCI/2kCwEO3TVFlo3vCtjZuSlC+uctC1zvHOFga6pZbzsKgs4/34nfIUhSKJPK7JSoxk++LPeYP+EjkfRLE76j9GfciSZVSRpl11FUlW4IokiChmSdfAuZIInTS4n/iEfrPNq5qq/d2SoUKUlTLogUd63IKa87+Z0Lox8btxCzZ/eHs+m3YFy84et4eHFYrc72KcBJGguUYmEu2W7Fo9AI/ZHZ0V3W6ZolWK4FyImOfFdgcTGrkv21DcyTbXIl2j9SLV29ov0b6xA+wnp6y5d7WfFOTc8DaH3d6zP8ZVR1r1kbobfnGYX8/71xwY+eHbWGau7F91uzhnec0uLxgoutpwJKWTRxPQvmDc6GXbqF2seWZmEl9rkD3N/7E3k7GIbKyyZQ1mpLZ/5piYzp7K//g5mp4V/GLuWSTvLet9frIHy6U/1jpVl2dniiXRrfj2mt2qmEk9eXwditif3pg+YSa5iVj//GQhcJXyf5H5zxv38XU4pjjnT7dRSZv8h4HPEzNt7u1eCLL2rzzT17v6+LP3L3q0EdXmb5bpsZD8T6vsvfZevfp3prR3Sx5PPD0mL8esN/SvUv5X0/FRZLmUCVjKg6/0OPRfvfJn2pR/5Y5nyGLX7l/6/1cMMByq4fD6v+w+/a5E8iv9kZHS70X0+I8ZP83l0AwyBkhvLnLjmZnEPjWx4OVueEx5XHtceYnwJiK5I+kV12VTkTEZCUuxAhkzB8TAN5uWU+jN6/PX58t0S7wPKSWGVtcphXxUBJR7esy0l7e9JWWJdfW+2GFLWkPiByFtzPoD12NLOmfFykuluJMsjpk2sZKTx9d+rvDkpSuN8s5DSlR+uc3p+1GKVHLSTD5aEqZC6TivwVm0KEHvXf364z9//s8/Ft/paaZV+Zf+q1e/FtdD7yPJmCtDDPXq1aX3xR0o344vnpDV36OYJ1/8OU9r+qbP0gnj9t5QCPicjT5XLLUD/9JlJH8eW+vfDPyxUNp0eHoyatxvcjKdmp//yEha3iikpBUpn5/8iCvzd1ScSw0v+5fZu37vmfScLzz6YpNzxuQC6WHMQ7tZ3oO5FWnhFWt7vepFZ3yYGCYsqpb6/sD/atjUr7zo9Mbq1pZFzeLzJj/mS/zrJzNQOYSTv3BmeMWfDmY9rsKQUt3Y9sYRaB9/++QP/FsRWbkRi8h0kezBH9j/v/SH/tCsWKR5ssTlU/77kz9hyV1m71l+Pqz55/8B/hy0tA== -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment ARCHIVE

- - - - - -**Required Permissions**: `Experiment Archive` or `Experiment Admin` - -## Request - -

Path Parameters

Body

required
- -The action to take on the experiment, the experiment id and a comment to go along with the action. - -
    = 1`"} schema={{"description":"The `id` of the experiment which you want to archive.","type":"integer","format":"int64","minimum":1,"example":13}}>
- -A JSON Object with experiment data, the experiment note and an array of errors. - -
Schema
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • new_experiment_notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • experiment_note object
    reply_to objectnullable
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • experiment object
    application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • experiment object
  • ]
  • preview_variants object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment object
  • ]
  • alerts object[]
  • Array [
  • experiment object
  • ]
  • sample_size objectnullable
    experiment object
    variant_screnshots object[]
  • Array [
  • experiment object
    file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-comment-create.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-comment-create.api.mdx deleted file mode 100644 index c78a5591..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-comment-create.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: experiment-comment-create -title: "Experiment Comment CREATE" -description: "**Required Permissions**: `Experiment Get` or `Experiment Admin`" -sidebar_label: "Experiment Comment CREATE" -hide_title: true -hide_table_of_contents: true -api: eJztXW1z27ay/iscfOmprxo7ceb0HH1zOm1v75k2mdi5XyJfBiZXFhqSYAHQL/Xov98BKImkRJESJdmS8mSmjUICC3D57GKxi10+sZB0oERqhExYn52cfKS/MqEo9D6QioXWQib65KTvffn5ISUlYkqM9yuZL55UlWsXYSySL6zHUq54TIaUZv3PTyzhMbE+o1nL30LWY8IOlnIzYj2mJiOyvlEZ9ZgORhRz1n9i5jG1fUVi6JYU67GhVDE3+aV/vmU9FotExFnM+q/H4+ucFGnzToaPtn/12a5G5AUydrM10rshTySalKHQE4lnRuQVk/R4YMSdMI+e4TevaiYZyMRQYuwoPE0jEXA7yumf2g71tPgM8uZPCoxlj5IpKSNI27sirJ/nFxF+8eRwflb3I1LkLk4f5F5EkX2UQBE3FNqprsO1HqMHHqcRsf7r83GPJdJQC+fowZRG0UaJ5JaV6LArephnMBu7P5aNOpWJzh/+zdnZ4lgX3v9cvv/De+/45Vk2c5GI5NbjXsqVEUEWcVXiyXd69q7stLb0Xgr6/pQlq7zIOda7B06jR99IezfJoojfWB7lGJqxzN7oNQ7AAqHck//je8t7YRynC/H7w06yNJybtV87qV7zPMa90sN3fO4yqiyonAp4aoCMIW380rDjHhOGFM8xUUO/JPc9pg03LQOoLLEgsoRDuqNIpu7dclPXbSYvITf0gxExLTAtH1VtSkGm3QksvrdhFkW+TCYk51uvMESJxh1XgidNhGpexlmPxfwh/221ScS18TVR4ovED2RIG7ErUdNZ6XpMzIZeouHslFJSASWG35Kum0nKjSFl9dBgED69GQ8Gp3M/KrA6f3t6fn56fl433WIkXw59o/hwKIIWYTk7s7AgChu5dCNuRS4kE6r+Gl0mC8Xqb6LU5+axXSFwFYzEXWU6N1JGxJPykw55pC2T+B03XNVRXeBn3tQfioj8LI0kD/1MRc1ifxoomX5S0enrs7OH12dnp69fpbkW2IwNfqZJLVOvFd0Ukl215nRpzUx/5+ormYmKopiL2iebzStvYVfU6VrwSecLTpdJZmm4HjNqXs+UBjCy/xgp3tWKk6xhdcVqa5r11Ujoqr1W7mpnkwjj5/27WlntFsb0OdebOXki1NYOl5nyLAm9U1wsiGK3Nbz+9bYs41DzByXC6/C/3D0R5so2L8vdsiesGPGpEjFXj35MRlXsmDVF9VbyqHXAH89WEuorEZPdab6T8uvaks1jmSXGbbItmRsaSkUe926k/Gr3myOuvRuixIt56Pg1p6JqyLpns9TsDowHI0F3NN3P0HBo2VTXP7Eo+sxSqYURd251pVs++ZklXxN5n7DrNV/6FEW+Nqp51k9jp9V0wCNaBQcUCF3lcJLFN9WW9v3d8SgjX8tMBeRPwPHYPBU2nsHo0aoAQy1z37GMV578JVWzRdYul8c0U8GIa1pLii48Oy1vKJVnFA9yqZH3XsyTR29KUXtckZMhTyaevTNZTkvumS2sqlix9n3F6mYBYTNy1LhofHeNk15k91rv0fDbsgOIK8UfmfM6xrodM8uNmJmuLjy2v0oeWa9tbh3w28aOtkF3RV/tXKfn9WMwkpG8FQGP+lcq03AKHbuMvdjuE7jYa1xsUfdazdWgTqu60P53xW+/r8xocnHhWuU68fi5lbYdc2kne7O7sqYHG2qYzal9E9BuxleAAaV+xMILgxq42LFSz/3dndVtMyY11b5zIGlvkDReafErVswr4vH3bI6KvehIFwGgRkiVj54UpItzLt+zMqk159b2QAunamazX8u+mTEid5VvIEI5gaUTnrrii+F/d1dWtFsaXl1OZ/L4peszhlTMtulFeZ9spDEaN87QJIesSRoWgzk0vbcgcldbxWcR9/PE2Maens6elkjmvu3+fxMPqwbbccWNF9XGZLu2qTpo0X6wLw5cKywApxD9DXf6u103sd+HtGC/D1zsBS6w3weSsN9/5v3+FiINXY0IHOWBnnhxPQFLBLjAUR4c5YGMHYruxVGeo8bFsR3lWRJQQ4AJ8N/DANNGu+ZKBHXtGU3INYVol8Vy8+tsIbWrNRfmjU3u4VkoKAlq96LlJPqnAcvzeAas/8STsD8YfL4ej1mJhM1QEpXUqAbJGT2m0oxIi5r0/Tw7KRRB/X7XDulu+akUVb9E0ULY4Sxu3W7WD8lwEdU3tfOoSU8az0TB9qbAWHH2F9K/atP/N7aFKzvxznpyFa9MaaRdejOE1Gs5Mt5nyhPvL61LAtbw8at9eCKAi+7WcHsIdr33uJLTu06hXhTKtLqal26wygBLkV7Syyu1uSOll1VZWigfU+s1r8zR5f0uFOlZc/0JZDIULe6PVdixdh2qjxR67zJjcm6XaiAth3e15lEtg/53QmfsivsEMgkLa2vHq/QKgEFC/3KySOhHQj8S+hEFhI0F2xu4QBQQUUDI2MvLGKKAwMW3EAXcidLGAX8I7z4KLwxq4AIH/IEkHPBffW5I6EdCPzTJN3feCgn9Ow1OIKEfWqGTVkBCP/b7kBbs94EL7PeBpBdHEvb7SOjHUR7oCVgiwMULWyI4yoOjPJAxHOUBLr7RozxI6Af8DyfAdOgJ/Y3u8tqN8uU0LW1KJE8MuhN0//IZapTcCSUT1ya/+zTLsQrpjiKZujHc8GGWp/9fT79wG9issFqAL6Q39thQKG18ekilzhRttNZGfFuUQm64H2RGDodbWf2706jFzoccJ2XM+JvngCK7EdmNyG5EdiNcorA/D2dbDpfoUeMCLlG4RCFje6p74RI9alwcm0t0J0obpx0hvPsovDCogQucdgSScNpx9bkhuxHZjdAk31zwGdmNOw1OILsRWqGTVkB2I/b7kBbs94EL7PeBpBdHEvb7yG7EUR7oCVgiwMULWyI4yoOjPJAxHOUBLr7RozzIbgT8DyfAdNTZjRtkCzZ+7q/4xN/RpBW6hKfSE8zSoormFIg4R01sVcOKbXNGBivTTmczWfIgi72HkeSOsyJOedDEhNa+fiTvc5XZmUKWpt0oNH0uspxW2Rpg2qpjChEjLIqHs1eAn+aocYGIEZB0sBGjuqV4RhZRG0RtIKuwBoALRG0QtYGM7YuMIWoDXCBqg6gN4P8sUZuuazcq0y30R2U6VKZbqTJdTeEMpN3tlPNIu8Oq22nVPdS0uw7p6rPayy98amNLjINhA8MGhs3zGjaI+MDreKALPSI+wAUiPoj4QMYOR/ci4nPUuDi2iM9OlPYWd+YIPUEO9zBhCK5xuMahFfZPK3R3jbfn5RXpdrsszdq95E27bGwpJQqCsP+C0KLLFmFUCEoJAW3r3La+ZlkZcYcLqDY8+Nq/4cFXSkLs4Y9fCLCHBy667+HbQ0ydU55K6/f8rr5ya1E9rqHT5yjZoJY0tOZM/5CGnP2S0L1fmsompIb8TiphGb6FBERI215LW5spsiUbYn3mzU30lwkmi5FdEx6R2uSjzTt+7PxKUc4jsKjOUj8hCilkPcazUFASkB8LHXMTjFiPafeGfS3+Jl8RD0au5eSqsi6GovV1R2BuIyIZk+H2S991FOYa1+q/C/vu3FssPXGDYt/td7dfiouK/sqEotCfY8KCkpiv0lI+ynH27zfnbx0xB5fuEyoRtTcqJDvMsJl4LSouXYtLO0ZR4sbXgaJEj+R2PtC+0tmYpuo6s4Zv3CkjRfnkKktN6xhvXXGcG2pZkSbVVbyfvtOepkAmoScMOT2QrKqqSvPqrhNzIprfUnca9cd2nPjJNF3VBlDklKNM/JBinqx6eKxgwkqW0S8iok+uedUCdNcdGypMWapZ7kVoRi1YOPuXPV42InE7akHcj2/OpsMuEcTp7fYjUhMD6U85SvxQ0szSkYkpF6NaTkDE/JZOJ91uuKZlBtZMNdj7k9ftRzQsP2xD2SLX3Mh0jdbzXG9rv8D7xg7wSxyzRbyqX2LCzg13SXjbLxyTKBsZrVZG3RI7WaIvZ/1rFox88W0soFb0r4YeynuelWxZHkxPus42Hu5FsN5cQUFtuLJ/K5r+olDkN2RquZdFkS8tDgMZT/pM4OrOcU9/d92GQCkeipjgsCtwsdsDV9ZjuYIroXljtki14hbtuHGZ2xm2G9aG8pqnJbVd7NlaX6E2vJ4VxQAqS5LJuytp9I1kzq0AG1KQ6TZdD5PVZ6Owz5RGCTQtcYPSyzibq6PrStlqosQXiR/IkDZiV6Kms9L1mJgNXcZHiU12SimpgBLDbyve/tlMUm5siVPWZ4NB+PRmPBiczv2owOr87en5+en5ed10i5F8OfSN4sNhJWmudltr96qaKsp5kUtF2eEJVX+NLjA7jnh56ThJmCDfFkZWNDnKSnSB1Wsk2grtFWv7d9ord51WW5/znW09u3H6nOumCItQT7MVc7fF0Z5ShZo/JBFeh//l7okwV7Z5We5WCu+kSsRcPfpI/l9OFsn/SP5H8j+S/7FiwR8KXCD5H8n/kLGXlzEkDgAXSP7fXfJ/V2WNr6lBeGFQAxf7qtTxNbVvGkkv8DW1anJKMzqKgd0y3fXoX/1TdC9bsJYlNGPZc1Xsfb5SxwuffUYdJOgc1EGqYx3qIKEOErTCMX4iAJ4BSAs8A8DFXuACngEgCZ6BvfUMbCF60dXcwPEgaJQX1yiwWYALHA/C8SDI2KHoXhwPOmpcHNvxIHwNHvA/nFDUM34Ntv1bAQvB3LYP3M6ni7Xm17gibdPinnWvq5yY/zRgeW7QgPWfeBL2B4PP1+MxK5GwWU+ikm7VIDmjx1SaEWlRUxIgz3gKRVC/350VD/JTKaoejKKFsMNZ3LrdrB+S4SKqb2rnUZPyNJ6Jgu1NgbHi7C+klNWWFNjYFq7sxDvrye36b0pz2qXfQ0i9lsvjfaY88f7SOi9gNx//AgGfBXCxy3r8673HztX7LwplWl33SzdWdJqX9PJKbe5I6WU1nhaK19RXxS7Psah2tcFKFchkKFocJauwY+0qWB8p9N5lxuTcbirbtaTiUlOxxLxwuKuHXNhle7OerwAtFB5YThaFB1B4AIUHEFmENQYrHbhAZBGRRcjYy8sYIovAxbcQWdyJ0kZ6AYR3H4UXBjVwgfQCIAnpBQeVXoDCAyg8AJ2zr6e9UHhgp2EMFB6AVuikFVB4AJ4BSAs8A8AFPANA0osjCZ4BFB7A8SBoFNgswMXB2Cw4HoTjQZAxHA8CLr7R40EoPAD4H04o6tALDzQ61ms3ypfTpLgpkTzZ6E7Q/SHlx1FyJ5RMXJv87tMswyukO4pk6qi5wcMsL2hwPf0OcGBz0mpFYSENs8eGQmnj00MqdaZoo1U54tuiFHLD/SAzcjjcip3QnUYtyj7kiCqjy988VxVZmMjCRBYmsjDhZoVNu982LdyswAXcrHCzQsYORffCzXrUuDg2N+tOlDbOWkJ491F4YVADFzhrCSThrOVBnbVEFiayMKFz9jX0jSzMnYYxkIUJrdBJKyALE54BSAs8A8AFPANA0osjCZ4BZGHieBA0CmwW4OJgbBYcD8LxIMgYjgcBF9/o8SBkYQL+hxOKOuoszA1yFRs/ilh8CPFokhpdElXpCWapVkVzCkScoya2qmHFtjkjg5Vpp7OZLHmQxd7DSHLHWRGnPGhiQmtfP5L3ucrsTCFL024Umj6qWU7qbA1FvZALC1EoLJ+Hs6uAR+eocYEoFJB0sFGoum+nz8givoP4DmQV1gBwgfgO4juQsX2RMcR3gAvEdxDfAfyfJb7Tde1GXbyF/qiLh7p4K9XFqynbgVS+nXIeqXxYdTutuoeaytchBX5WTfqFz3dsiXEwbGDYwLB5XsMGER94HQ90oUfEB7hAxAcRH8jY4eheRHyOGhfHFvHZidLe4s4coSfI4R6mFsE1Dtc4tML+aYXurvH2DL4iMW+X5V67F8dpl41nT56CyOy/yLRovcV3X4hUCQFtK+Lzf8mzMrcdLsra8OBr/4YHXykJ4Rc4fnGBXwC46O4XaA9bdU6jKtkE856Cyq1F9biG9p+jZANl0tCaM/1DGnI2UUL3fmkqm5Aa8juphGX4FpIaIW17LW1tRsuzWxvrs3nukX6ZoLc8sgVDRGqTT1vvDYPyK0WBksBKSpb6CVFIIesxnoWCkoD8WOiYm2DEekw71Pha/E2+Ih6MXMvJVWVdIUXr645g30bkNCbD7ZfT6yjMNa7VqRf2Lbv3XXrihsViX75j/lL8VvRXJhSF/hy7FlTUfIWa8uGUs3+/OX/riDlgdZ9Qiai9USHZYYbNxGvxc+laXNoxivI+vg4UJXokN9EfbSCYO+3TVFlo1vCNOzelKJ9cZaFrHeOtKwx0Qy3r4aSyjPfTd9rTFMgk9IQhpzGS7au/0hN018g5Ec1vqTuN+iNLTlBlmq5qqyhyClcmfkgxT1Y9OFcwYSUL7hcR0SfXvGqpuuuODRWmLNVB9yI0oxbUnP3LHq0bkbgdtWDzxzdn02GXiOz0dvvxsIkh96ccJX4oaWaRycSUS3YtJyBifkunk243XNMyQ3CmROz9yev2IxqWH7ahuJNrbmS6Rut5rre1X+B9Ywf4T47Zcl/VfzJh54a7ObztF47HlM2RVnukboc/WcwvZ/1rFox88W0sM1f0r4ZdSmt5zVuec1Cs6sNRlEaP9kD7nHOjk2+jdrL2nh1Jfq1Btn1nSsmV5GZqJUz+uN3MSIb23JvUTp64VfXstOSXOn0q/vFbOD7lgRF3wljymtSdE9jPT2456rORManun55qnoQ38uEVv9ExVyZ6fBXImI2vbZ8gU7a77WSBc5GK/5D953X59mUwojiX6nKj4gnzCz0mEjtsHiOfO5rNLjzb17v48Jv3H3p057Dtb56ZkVTib2civvJOTn7PtPFuyBOJZ0bk5Uj3BuwiFT/Yjo8yy3WTz1Phf6XHATs5YVMbjF2U6Vm2uLmzPvu/CYHBQA8Gl//l3u6fWiYf6a+MtHknw8efp1KYW3qvz3MfmwsRPhibu+HmpUkZchEHkQyl48MEJdNgRI/ZV5E/9+tXZ6/OFrmReO9TSiwHLlMKxHByuNwzI268vO0NaceCi3eT9+YYZhl3L5U7v34vzMgxxCthxEuVvFU8jrmx5yajx1csN37yMpbWkBcBJTrf6OZc+6BkqgQZrh4dYywC47we56RFIQDeTzLO//7488XVz/OP9jQ1tFifnZx8nOwYvQ+kYqEtT/TJSd/7UqL3K5kvnlSVaxdhLJIvbCbihh7MaRpx4WRsou9zAflccdz2WL8sItbBMZWR6x4bWcnqf2ZPT9as+6Si8dhe/isj5VA/0ZpOxXx+YqHQ9nc4WacanvQf0wf93ls26amwJFZSJgVJGeuxr1aWWGXS42tnNjs5svPIm/yUj/bDlSVUkCilJpxaQLNxb9rjIggoNY1tr0t658P7yyvWYzcydNIdy9D2Ufye9dz/+2zABnbKMs0TIfpP+fUnFvHkNnN7KJbTtX/+H0efQRM= -sidebar_class_name: "post api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Comment CREATE

- - - - - -**Required Permissions**: `Experiment Get` or `Experiment Admin` - -## Request - -

Path Parameters

Body

required
- -The comment to be inserted in the experiment activity tab. - -
    = 1`"} schema={{"description":"The `id` of the experiment where the comment will be created.","type":"integer","format":"int64","minimum":1,"example":13}}>
- -A JSON Object containing a particular experiment's activity. - -
Schema
    experiment_note object
    reply_to objectnullable
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • experiment object
    application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • experiment object
  • ]
  • preview_variants object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment object
  • ]
  • alerts object[]
  • Array [
  • experiment object
  • ]
  • sample_size objectnullable
    experiment object
    variant_screnshots object[]
  • Array [
  • experiment object
    file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-comment-reply-create.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-comment-reply-create.api.mdx deleted file mode 100644 index 3399eea5..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-comment-reply-create.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: experiment-comment-reply-create -title: "Experiment Comment Reply CREATE" -description: "**Required Permissions**: `Experiment Get` or `Experiment Admin`" -sidebar_label: "Experiment Comment Reply CREATE" -hide_title: true -hide_table_of_contents: true -api: eJztXVFz27ay/iscvPTUV42dOHN6jt6cTtvbe6ZNJnbuS+TLwOTKQkMSLAjaVjX673cAUiIpUaRESbakfJk5c1wKWICLbxeLXexywnxKPCViLWTE+uzs7CP9lQpFvvOBVCiSRMgoOTvrO19+fopJiZAi7fxK+osjVeXZlR+K6AvrsZgrHpImlbD+5wmLeEisz2je8jef9Zgwg8Vcj1iPqXxE1tcqpR5LvBGFnPUnTI9j01dEmu5JsR4bShVynT3651vWY6GIRJiGrP96Ou3NB/NkuNZI1Xe/GZHzRfhfHDl09IicnIrzOCJF9omiOBg7jyIInDtyPEVck/+KdZ/ybTYnSvQ76Y9N/+UpZYNqaYYUUUJKk++IqDzFVzXv5slIU6QNTR7HgfC4oXn+Z2IIT5ZnLO/+JE+b9VMyJqUFJeZX4dfPqiOjNmFPj9ETD+OAWP/15bTHIqmpkUX0pEtjJFqJ6J6VqLAbetI5J00XQT6b2n+GfUksoyR76TcXF8sDXTn/c/3+D+e95ZNj2MtFJKJ7hzsxV1p4acCVU+D8u8ThnhYPQo/NrHa0HgV9d8aPdRZwge/2heNg7Gppfo3SIOB3hkUZduYcMz/0GgdgnlD2zf/xvWG90JbRhV74w0yyNJydtVs7qV7zPKa90st3fO8ypAyirLqYNCBGU6Ld0rDTHhOaFM8wUUO/JN09lmiuWwZQaWRAZAj79ECBjO3acl3XbS4sPtf0gxYhLTEtG1VtS0HG3Qksr9swDQJXRjnJxdZrDFGi8cCV4FEToZrFuOixkD9lfxtVEvBEuwlR5IrI9aRPW7ErUrNZJfWYmA+9Qr2ZKcWkPIo0v6ekbiYx15qU0UODgT95Mx0Mzhf+qMDq8u355eX55WXddIuRXDl0teLDofBahOXiwsCCyG/k0p24F5mQ5FTdDbrku8T6K1HqczduVwhceSPxUJnOnZQB8aj8pkMeJIZJ/IFrruqoLvEza+oORUBuGgeS+26qgmaxP/eUjD+p4Pz1xcXT64uL89ev4kwLbMcGN01IrVKvFd3kk9m1FnRpzUx/5+or6VxFUchF7ZvN55W1MDvqbC/4lGQbTpdJprG/GTNqlmdGAxg5fIwUa7XmJGtYXbHammZ9MxJJ1V4rdzWziYR2s/5drax2C2P2npvNnBzhJ8b+lqlyDIlkr7hYEsVue3j98rZs41DzRyXCm/C/3D0S+sY0L8vdqjesGPGxEiFXYzckrSp2zIaiei950DrgjxdrCfWNCMkcNN9J+XVjyeahTCNtD9eGzB0NpSKHO3dSfjXnzRFPnDuiyAm5b/m1oKJqyNp3M9TMCYx7I0EPNDvP0HBo2FTXPzIo+sximQgtHuzuSvc8/zONvkbyMWK3Gy76DEVuolXzrCdTq9USjwe0Dg7IE0mVw1Ea3lVbmvV74EFKbiJT5ZGbg2PcPBU2ncNobFSAppa571nGK2/+kqrZIGuf22OcKm/EE9pIiq4cMy1nKJWjFfcyqZGPTsijsTOjmDhckZUhR0aO+SXfTkvumR3sqtixDn3H6mYB4TBy0rhoXLvGSS+ze6N11Py+7ADiSvExs17HMGnHzGojZq6rC4/tr5IHxmubWQf8vrGjadBd0Vc71+n5ZOyNZCDvhceD/o1KEziFTl3GXuz0CVwcNC52qHuN5mpQp1VdaP53w++/r8wof7j0rPKcePjcStuMubKT+bG7sqYnE2qYz6n9ENBuxleAAaV+wsILgxq42LNSz/zdndVtMyYTql1zIOlgkDRda/Mrdswb4uH3bIGKeWhJFwGgRkiVr54UpIt7Lt+zMqkN59b2Qku3auaz38i+mTMic5VvIUIZgZUTnrnii+F/t0/WtFsali6jk79+6fmcIRWzbfZQPkZbaYzGgzM0yTFrkobNYAFN7w2I7NNW8VnG/SIxtrWnp7OnJZCZb7v/38T9qsF2WnHjZbWRH9e2VQct2g/2xZFrhSXgFKK/5Ul/v/smzvuQFpz3gYuDwAXO+0ASzvvPfN7fQaShqxGBqzzQEy+uJ2CJABe4yoOrPJCxY9G9uMpz0rg4tas8KwJqCDAB/gcYYNrq1FyJoG48o5xcU4h2VSw3e86WUrtac2HemOQenvqCIq/2LFpOop8MWJbHM2D9CY/8/mDw+XY6ZSUSJkNJVFKjGiRnNI6lHlEiatL3s+wkX3j1510zpP3JjaWo+iWKFsIMZ3BrT7OuT5qLoL6pmUdNetJ0LgqmN3naiLO7lP5Vm/6/tS1cOYl31pPreGVKI+3TmyFkspEj432qHPH+2rgkYA2fvtqHJwK46G4Nt4dgN1vHtZzedQr1qlCm1d289AOrDLAS6SW9vFabB1LJqipLS+Vjar3mlTnavN+lIj0b7j+ejIaixf2xDjs2rkP1kXznXap1xu1SDaTV8K7WPKpl0P/mdKa2uI8nI7+wtva8S68BGCT0ryaLhH4k9COhH1FA2FiwvYELRAERBYSMvbyMIQoIXHwLUcC9KG1c8IfwHqLwwqAGLnDBH0jCBf/154aEfiT0Q5N8c/etkNC/1+AEEvqhFTppBST047wPacF5H7jAeR9IenEk4byPhH5c5YGegCUCXLywJYKrPLjKAxnDVR7g4hu9yoOEfsD/eAJMx57Q3+gurz0oX8/S0mZEssSgB0GPL5+hRtGDUDKybbJfJ/McK58eKJCxHcMO76dZ+v/t7Au3nskKqwX4Unpjjw2FSrRLT7FMUkVb7bUB3xUln2vueqmWw+FOdv/uNGqx8yHDSRkz7vY5oMhuRHYjshuR3QiXKOzP4zmWwyV60riASxQuUcjYgepeuERPGhen5hLdi9LGbUcI7yEKLwxq4AK3HYEk3HZcf27IbkR2IzTJNxd8RnbjXoMTyG6EVuikFZDdiPM+pAXnfeAC530g6cWRhPM+shtxlQd6ApYIcPHClgiu8uAqD2QMV3mAi2/0Kg+yGwH/4wkwnXR24xbZgo2f+ys+8XcyaYU24an0BvO0qKI5eSLMUBMa1bBm24yR3tq04/lMVrzIcu9hILnlrAhj7jUxobWvG8jHTGV2ppDGcTcKTZ+LLKdVtgaYduqYQsQIm+LxnBXgpzlpXCBiBCQdbcSobiuek0XUBlEbyCqsAeACURtEbSBjhyJjiNoAF4jaIGoD+D9L1Kbr3o3KdEv9UZkOlenWqkxXUzgDaXd75TzS7rDrdtp1jzXtrkO6+rz28gvf2tgR42DYwLCBYfO8hg0iPvA6HulGj4gPcIGIDyI+kLHj0b2I+Jw0Lk4t4rMXpb3DkzlCT5DDA0wYgmscrnFohcPTCt1d4+15eUW63T5Ls3YvedMuGztKiYIgHL4gtOiyZRgVglJCQNs+t6uvWVZG3OMGmmjufe3fce8rRT7O8KcvBDjDAxfdz/DtIabOKU+l/XvxVF/5aVk9bqDTFyiZoJbUtOFM/5CarP0S0aNbmso2pIb8QSphGL6DBERI20FLW5spsiMbYnPmLUz0lxyTxci2CQ9IbfPR5j2/dvakKOfhGVSnsRsR+eSzHuOpLyjyyA1FEnLtjViPJXaF3UT8Ta4i7o1sy/ypMi6GovVtR2DuIiIZkubmS991FBYa1+q/K7N2dhVLb9yg2Pf73e2X4qKiv1KhyHcXmLCkJBartJSvclz8+83lW0vMwqX7hEpEzQ8Vkh1m2Ey8FhXXtsW1GaMoceMmnqIoGcndfKB9rbsxTdV15g3f2FtGirLJVbaa1jHe2uI4d9SyI+XVVZyfvkuchDwZ+Y7QZPVAtK6qKs2ru07MiCT8nrrTqL+2Y8VPxvG6NoAiqxxl5PoU8mjdy2MFE9ayjH4RAX2yzasWoH1u2VBhykrN8ih8PWrBwsW/zPWyEYn7UQvifnxzMRt2hSDOfm6/IpUbSH/KUeT6kuaWjox0uRjVagIi5Pd0nne74wmtMrDmqsH8ni+3G9Cw/LINZYtscy3jDVovcr2t/RLvGzvAL3HKFvG6fomcnVuekrDaLxyTKBsZrVZG3Rabb9HX8/41G0a2+TYWUCv6V0MP5TPPWrYs92Y3XecHD7sQrLdQUDDRXJn/VzT7i3yR/SBjw700CFxpcOjJMO+Tw9Xe45793fUYAqV4LGKCy67AxX4vXBmP5RquhOaD2TLVilu048Fl4WTYblhrymqeltR2cWZrXcJE83pWFAOoNIrytStp9K1kzu4AW1KQ8S5dD/nus1XYZ0ajBJqWuEFpMS4W6ujaUrYJUeSKyPWkT1uxK1KzWSX1mJgPXcZHiU1mSjEpjyLN7yve/vlMYq5NiVPWZ4OBP3kzHQzOF/6owOry7fnl5fnlZd10i5FcOXS14sNhJWmu9lhrzqoJVZTzMpeKssM5VXeDLjA7Tnh76ThJmCDfFkbWNDnKSnSJ1Rsk2orEKfb27xKn3HVWbX3Bd7bz7MbZe26aIiz8ZJatmLktTvaWKtT8MYnwJvwvd4+EvjHNy3K3VngnViLkauwi+X81WST/I/kfyf9I/seOBX8ocIHkfyT/Q8ZeXsaQOABcIPl/f8n/XZU1vqYG4YVBDVwcqlLH19S+aSS9wNfUqskpzegoBrbbdNerf/Vv0b1swUaW0Jxlz1Wx9/lKHS999hl1kKBzUAepjnWog4Q6SNAKp/iJAHgGIC3wDAAXB4ELeAaAJHgGDtYzsIPoRVdzA9eDoFFeXKPAZgEucD0I14MgY8eie3E96KRxcWrXg/A1eMD/eEJRz/g12PZvBSwFc9s+cLuYLtaaX2OLtM2Ke9YtVzkxfzJgWW7QgPUnPPL7g8Hn2+mUlUiYrCdRSbdqkJzROJZ6RImoKQmQZTz5wqs/786LB7mxFFUPRtFCmOEMbu1p1vVJcxHUNzXzqEl5ms5FwfQmTxtxdpdSympLCmxtC1dO4p315G79N6U57dPvIWSykcvjfaoc8f7aOC9gN5/+BgGfBXCxz3r8m61j5+r9V4Uyre77pR/WdJqX9PJabR5IJatqPC0Vr6mvil2eY1HtaoudypPRULQ4StZhx8ZVsD6S77xLtc643VS2a0XFpaZiiVnhcFsPubDLDmY/XwNaKDywmiwKD6DwAAoPILIIawxWOnCByCIii5Cxl5cxRBaBi28hsrgXpY30AgjvIQovDGrgAukFQBLSC44qvQCFB1B4ADrnUG97ofDAXsMYKDwArdBJK6DwADwDkBZ4BoALeAaApBdHEjwDKDyA60HQKLBZgIujsVlwPQjXgyBjuB4EXHyj14NQeADwP55Q1LEXHmh0rNcelK9nSXEzIlmy0YOgx2PKj6PoQSgZ2TbZr5N5hpdPDxTI2FKzg/tpVtDgdvYdYM/kpNWKwlIaZo8NhUq0S0+xTFJFW+3KAd8VJZ9r7nqplsPhTuyE7jRqUfYhQ1QZXe72uarIwkQWJrIwkYUJNyts2sO2aeFmBS7gZoWbFTJ2LLoXbtaTxsWpuVn3orRx1xLCe4jCC4MauMBdSyAJdy2P6q4lsjCRhQmdc6ihb2Rh7jWMgSxMaIVOWgFZmPAMQFrgGQAu4BkAkl4cSfAMIAsT14OgUWCzABdHY7PgehCuB0HGcD0IuPhGrwchCxPwP55Q1ElnYW6Rq9j4UcTiQ4gnk9Rok6hKbzBPtSqakyfCDDWhUQ1rts0Y6a1NO57PZMWLLPceBpJbzoow5l4TE1r7uoF8zFRmZwppHHej0PRRzXJSZ2so6oVcWIhCYfs8nlMFPDonjQtEoYCko41C1X07fU4W8R3EdyCrsAaAC8R3EN+BjB2KjCG+A1wgvoP4DuD/LPGdrns36uIt9UddPNTFW6suXk3ZDqTy7ZXzSOXDrttp1z3WVL4OKfDzatIvfL9jR4yDYQPDBobN8xo2iPjA63ikGz0iPsAFIj6I+EDGjkf3IuJz0rg4tYjPXpT2Dk/mCD1BDg8wtQiucbjGoRUOTyt0d423Z/AViXn7LPfavThOu2w8e/IURObwRaZF6y2vfSFSJQS07YjP/yXPytz2uCknmntf+3fc+0qRD7/A6YsL/ALARXe/QHvYqnMaVckmWPQUVH5aVo8baP8FSiZQJjVtONM/pCZrE0X06Jamsg2pIX+QShiG7yCpEdJ20NLWZrQ8u7WxOZsXXumXHL3lkQ0YAlLbfNr6YBiUPSkKlHhGUtLYjYh88lmP8dQXFHnkhiIJufZGrMcSixo3EX+Tq4h7I9syf6qMK6RofdsR7LuInIakuflyeh2Fhca1OvXKrLJd79IbN2wWh/Id85fit6K/UqHIdxfYtaSiFivUlC+nXPz7zeVbS8wCq/uESkTNDxWSHWbYTLwWP9e2xbUZoyjv4yaeoigZyW30RxsIFm77NFUWmjd8Y+9NKcomV9noWsd4awsD3VHLfphXlnF++i5xEvJk5DtCk9UY0e7VX+kNumvkjEjC76k7jforS1ZQZRyva6sosgpXRq5PIY/WvThXMGEtC+4XEdAn27xqqdrnlg0VpqzUQY/C16MW1Fz8y1ytG5G4H7Vg88c3F7NhV4js7Of262G5IfenHEWuL2lukclIl0t2rSYgQn5P53m3O57QKkNwrkTM7/lyuwENyy/bUNzJNtcy3qD1Itfb2i/xvrED/CenbLmv6z/J2bnlaQ6r/cLxmLI50mqP1J3w8838et6/ZsPINt/GMnNF/2rYpbSX16zygoNiXR+OojgYmwvtC86NTr6N2sma38xI8msNss2aKSXXkpuZlZD/s6eZkfTNvTeZWHniRtWz85Jf6nxS/Mdv/vSce1o8CD0+n3gynD20PDDnNVIPVoQ/T+wG1WcjreOkf36e8Mi/k0+v+F0ScqWD8StPhmx6a/p4qRLm5vvniYXSVSz+Q+Y/b8s/X3sjCjM5Lzcq3jl70GMiMsNmUfOFy9rsyjF9nasPvzn/obG9mW3+5qkeSSX+tkbjK+fs7Pc00c4dOSJy9IicDPvOgF3F4gfTcSzTTFu5PBbuVxoP2NkZm1ll7KpMz7DFzp312f/lBAaDZDC4/i+73n8mMvpIf6WU6HfSH/88k8vM9nt9mXndbNDwSZtsjjtyDL8F2RCEiIbSsiGHzSw60WNmJbLXfv3q4tXFMjMi531MkWHAdUyeGOa3zR094trJ2t5RYjlw9S5fNssvw7dHqeyF9kehR5YfTgk0TqzkveJhyLW5SBmMX7HMGsrqWhrLXngUJdnJN2PaByVjJUhzNbZ8MZAMswKdeYtCIpyfMuw5Hw3wnJ8+/nx18/PiC05m9hfrs7Ozj/lB0vlAKhSJ4UxydtZ3vpSo/kr6iyNV5dmVH4roC5tLvqYnfR4HXFjRy7eBTG4+V/y5PdYvS47xe+SiY36aCw/LNQi77bGRkcL+ZzaZGBPwkwqmU/P4r5SUlYdcw1p19HnCfJGYv/18T2t4/X/M3v57Z9WbzMQoMtPLi5cy1mNfjZSxyptMex3HNmlFX4T/xSYVjcjJmeA8jkiRfWJZ4TyKIDAwz3e9V93mXLB4emvPBFYlGMZlv/+UTfGHG0Ol6F/Kuzg3smlfN+tx5XkU68a2tyWl+uH99Q3rsTvpW0UVSt/0UfzRrDl/ZH02YAMzXxlnWR79SfZ8wgIe3af2gMgyuubf/wOiA78y -sidebar_class_name: "post api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Comment Reply CREATE

- - - - - -**Required Permissions**: `Experiment Get` or `Experiment Admin` - -## Request - -

Path Parameters

Body

required
- -The reply to be inserted in the comment. - -
    = 1`"} schema={{"description":"The `id` of the comment where the reply will be created.","type":"integer","format":"int64","minimum":1,"example":13}}>
- -A JSON Object containing a particular experiment's activity. - -
Schema
    experiment_note object
    reply_to objectnullable
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • experiment object
    application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • experiment object
  • ]
  • preview_variants object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment object
  • ]
  • alerts object[]
  • Array [
  • experiment object
  • ]
  • sample_size objectnullable
    experiment object
    variant_screnshots object[]
  • Array [
  • experiment object
    file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-full-on.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-full-on.api.mdx deleted file mode 100644 index 5c43cbd2..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-full-on.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: experiment-full-on -title: "Experiment FULL ON" -description: "**Required Permissions**: `Experiment Full On` or `Experiment Admin`" -sidebar_label: "Experiment FULL ON" -hide_title: true -hide_table_of_contents: true -api: eJztXVtz20aW/isovGTi5Viy5NrM8E1OjXdnZyZ2Rfa+mFq4BRyKHQNopLshWdHwv291AyQAEgRAkBQv+lI1E4XoG05/5/Tpc8OTG5DyJU80F7E7dF+9+pV+T7mkwPlIMuJKcRGrV6+Gzte/fU9I8ohi7bxPw9D5EH91hKz8fhVEPP7qDtyESRaRJqnc4ZcnN2YRuUOX5i3/HrgDl5sJE6Yn7sCV+azuUMuUBgur+jQh5ysPvjpi7OgJOcVAzsOE+xPnUaTOA4u1o4WTpNoZmwWK+LU7cJU/oYi5wydXPyZmFTzWdEfSHbhjISOms5/+8607cCMe8yiN3OGb6fQmWxQp/U4Ej6b/8pryaZx7JrmZncWBwxxJiZDarPVh8ujoCVflBXPl3BKP7xbXuUgBX8SaYm0mZkkScp+Zic9+U2b2p+XXEre/ka8N7aVISGpOyjw1M3gi9vIlNtPhjfNv58L5t3PpDlz6zqIkJEOLgRsLTaWuSkse35UbuR9Trc1bzUjxZk4cppwHchR7cBS/i/mY++Y5j31JTJHDY8cX8T1JizR3av8x5FCJiFX2Ehfn58sbcOX8z/WHX5wP9r2dB64nZTIHTLPBIljMa2SbFDtMSvZoNomkFFKZLdgSybMBS+3sVAbwmiK1TEbzusUi28fnQe0uVjfMclzThmlS2itNO7Xrkyyjbs34JeYYuEqzNkTINI7t6xluvqdQJGYej+m6bnMIBkzTnzWPyB24cRqG7NYMZlgim1VuOoJI+g9Qej3zYDqYs1c25GLrDlOUxiix6IqBajbjfOBG7Hv29+V04IZMaU8RxR6PPV8EtBG5YjlblarHxHzqMj5KZDJLSkj6FGt2RzXgN2eF1iQNR49GwdPFdDQ6W/ijAqvLt2eXl2eXl3XLLWbyxNjTko3H3G9hlvNzAwuioJFKt/yOZ0ySj+qt0cVIOk1B950o9bl9bBcITPoTfl9Zzq0QIbG4/KZjFipDJHbPNJN1oy7RM2vqjXlIXpqEggVeKsNmtj/zpUg+y/Dszfn59zfn52dvXieZFNiMDF6qSHorZF9FNgWUMKkXZGnNSv/F5DfSuYiiiPHaN5uvK2thhLXm2g7wWZHsu8g0CdYjRs32zMYARg4fI8VedVxkDakr+k/Tqj9Vdc4flFPualYTc+1l/XtpG500jNl7rrdycnigjF4mUumYIdROcbHEiv3O8PrtbTnGIeaPioXXoX+5e8z1J9O8zHer3rCixCeSR0w+ehFpWdFj1mTVO8HC1gl/Ou/E1J94ROaW/U6Ib2tzNotEGtubsdl455bGQpLDnFshvpnL44SZyzHFTsQCS68FEVUzrH03M5qnhcf8Cad7mt1naDw2ZKrrHxsUfXETobjm9/Z0pTuW/5nG32LxELs3a276DEWe0rJ51U9TK9WUz0LqggPyuapSOE6j22pLs3/3LEzJUyKVPnk5OB6bl+JO5zB6NCJAU8vad8zjlTffp2g2yNrl8Zik0p8wRWtx0ZVjluWMhXS0ZH7GNeLBiVj86MxGVA6TZHnI2l/ix9lxWrJqbOFUxYl16CdWPw0Il5GTxkXj3jUuepnca+2jZnddrKIrMLNaiZnLatfn0k9DJv/0X4KFP7q55qPZXWNH06C/oK92rpPz6tGfiFDccZ+Fw08yVTAKnTqP7e32CVwcNC62KHuN5GoQp1VZaP73id39WFlR/uPSb5XfiUXPLbTNnCs7mYf9hTV9N66G+ZraLwHtanwFGBDqJ8y8UKiBix0L9cze3VvcNmNSUe2eA0kHg6Rpp8OvODE/EYt+dBdGMT8uxJQ0QqocelIMXUR1/eiWh1pzbW0vlK+7mG2++rX0mzkhMlP5BiyUDbBywTNTfDH9v+wvHfWWhq3Lxslfv/T7nCAVtW32o3iIN5IYjRdnSJJjliQNh8ECmj4YENlfW9lnGfeLg7kbW3p6W1pCkdm2h/9NLKgqbKflN14WG/l1bVNx0CL9oF8cuVRYAk7B+hve9Hd7buK+D27BfR+4OAhc4L4PJOG+/8z3/S14GvoqEQjlgZzYu5yAJgJcIJQHoTzgsWORvQjlOWlcnFoozwqHGhxMgP8BOpg2ujVXPKhrrygfrslFu8qXm/3uLqV2tebCXJjkHpYGnGK/9i5aTqJ/GrlZHs/IHT6xOBiORl9uplO3NITJUOKV1KgGzpk8JkJPSPG62hU2Oyngfv1910xpH3mJ4FW7RNGCm+kMbu1t1gtIMx7WNzXrqElPms5ZwfQmXxt29pbSv2rT/zfWhSs38d5ysotVpjTTLq0ZXKi1DBkfUunwD9fGJAFt+PTFPiwRwEV/bbjdBbvePnYyetcJ1KtCmFZP89IDtzLBSqSX5HKnNnmxq9o9XCofU2s1r6zR5v0uFelZ8/zxRTzmLeaPLuRYuw7VrxQ471KtM2o3lSlbUfOolkD/m48ztcV9fBEHhba141O6A2CQ0L96WCT0I6EfCf3wAkLHgu4NXMALCC8geGz/PAYvIHDxEryAOxHaCPAH8x4i80KhBi4Q4A8kIcC/+9qQ0I+EfkiSFxdvhYT+nTonkNAPqdBLKiChH/d9cAvu+8AF7vtA0t6RhPs+EvoRygM5AU0EuNizJoJQHoTygMcQygNcvNBQHiT0A/7H42A69oT+RnN57UX5epaWNhskSwy65/Sw/ww1iu+5FLFtkz19mudYBXRPoUjsHHb6IM3S/29mX7j1TVZYLcCX0hsH7phLpT36ngiVStrorA3ZtkYKmGaen2oxHm/l9O8/Ri12PmY4KWPG2zwHFNmNyG5EdiOyG2EShf55PNdymERPGhcwicIkCh47UNkLk+hJ4+LUTKI7EdqIdgTzHiLzQqEGLhDtCCQh2rH72pDdiOxGSJIX53xGduNOnRPIboRU6CUVkN2I+z64Bfd94AL3fSBp70jCfR/ZjQjlgZyAJgJc7FkTQSgPQnnAYwjlAS5eaCgPshsB/+NxMJ10duMG2YKNn/srPvF3MmmFNuGp9AbztKiiOfk8ylATGdHQsW1GSL/z2Ml8JSteZLn3OBTMUpZHCfObiNDa1wvFQyYye4+QJkm/EZo+F1lOq2x1MG3VMAWPEQ7F47krwE5z0riAxwhIOlqPUd1RPB8WXht4bcCr0AaAC3ht4LUBjx0Kj8FrA1zAawOvDeD/LF6bvmc3KtMt9UdlOlSm61SZrqZwBtLudkp5pN3h1O116h5r2l2PdPV57eU9R21siXBQbKDYQLF5XsUGHh9YHY/0oIfHB7iAxwceH/DY8cheeHxOGhen5vHZidDe4s0crifw4QEmDME0DtM4pMLhSYX+pvH2vLwi3W6XpVn7l7xp540tpUSBEQ6fEVpk2TKMCkYpIaDtnNvW1ywrM+7wAFWa+d+Gt8z/RnGAO/zpMwHu8MBF/zt8u4upd8pT6fxevNVXHi2LxzVk+sJIxqklNO3g5iIpCR89LeqINt8982DQOEFBKGtFWHqfX4Sm8nSeeZ1u9paFdVSoutHZxfyZz2/mks4YwB0slFZQmknzb0mzvyjg2QORGNSmYegJw/++iPI+uZiwHu3Z3zc4tk5bPMHtB1zs2PRs5GbdEpYaNhWAWR6VHryyVG1GU5uwb5+h8yk9Py9KfRdI0OHINqfPqpM6O5mWV4jzFuct5Ophy1Wct8AFztsjPW/H7F5IbvZkC6VswJAHzZBtRu0taRjrE29hoe9zTJZ4yzRhIcnmbyn0Uwa3VejO/lJSqwyq08SLiQIKjHKUBpxin7yIq4hpf2J0KbvDnuJ/kCeJ+RPbMv9VGmd10bqvIrWNQzcizQKmWQchXCtvrsze2V0svXGDMFyxhXtD6HaoKOn3lEsKvAUiLAmJxXqf5aSA879eXL61g1m49F/Q8hWjGLLHCpsHr0XFtW1xbeYozm5P+ZJiNRGb8HobCBayLJrUhnnDC5uvIilbXOWoaZ3jrS2zekstJ1Jep9P5+QflKPJFHDhck5UDcVdRVVpXf5mYDaLYHfUfoz4BxLKfSJKuOoAkKxxF7AUUsbhrGlJBhE6Ohfc8pM+2eVVjsr9bMlSIslKyPPBAT1qwcP4Xk6g0IX43aUHcTxfns2lXMOLscXuyTa4g/SYmsRcImms6ItblssarB+ARu6OzvNstU7RKwZqLBvM8324vpHH5ZRsK4NrmxsTQvfUi1dvaL9G+sQNMF6esEXc1XeTk3PCWhN3ec3RbWclo1TLqjtj8iL6e9685MLLDt7EUd9G/GsRWvvNUdNmF+/8LM3j3eu8FJa/9jNSUFcIv7UChfrWCWWlWb6UqJpBpHOcoLhnbN7pTWOP8hiOIZJu3iNwxsFEs0GyMkmLeYjYrbcb5wscV7PcNFFHs8djzRUAbkSuWs1WpekzMpy7jo0Qms6SEpE+xZncV79Z8JQnTpu69O3RHo+DpYjoanS38UYHV5duzy8uzy8u65RYzeWLsacnG40olhVoN1aidiirH1DKVim9R5KN6a3SBWnXKB22/RcI79LIw0tEbVBaiS6Reo/oKV05xtv+gnHLX2Sd4Fq7BWy95MXvPdevG8EDNSlhkN5CTTV2CmD8mFl6H/uXuMdefTPMy33Wy1CaSR0w+eqgItXpYVIRCRajdiGZUhMLF5MhPLISqAReoCIWKUOCxY5G9yCY9aVygItR2KkL1Fdb4xC6YFwo1cHGoQh2f2H3RSNrDJ3a3Fmdev7b+FarW0m/mhHiujzM831ct5gRByUtIki2lP6Hk5XH7jVHyElKhl1Q41q9B4b4PbsF9H7g4CFzgvg8k4b7/zPf9LXga+ioRCOWBnNi7nIAmAlwglAehPOCxY5G9COU5aVycWijPCocaHEyA/wE6mLb30cC1V7T8saclF+0qX27xVahqaldrLoytjTSrqVe3XeUk+qeRm+XxjNzhE4uD4Wj05WY6dUtDmAwlXkmNauCcyWMi9IQUr0nfz7KTAu7X33fnNZi9RPCqXaJowc10Brf2NusFpBkP65uaddSkJ03nrGB6k68NO3tL6V+16f8b68KVm3hvOdnFKlOaaZfWDC7UWoaMD6l0+IdrY5KANnz6Yh+WCOBil59JWm8fe39U6aoQptXTvPTArZalWlkurejRqc09SbWqytJS+Zj6ErPlNRaVvjY4f3wRj3mL+aMLOdauQ/UrBc67VOuM2k3FSVfUPGqqPJZV4bXFRQtta8endAfAIKF/9bBI6EdCPxL64QWEjgXdG7iAFxBeQPDY/nkMXkDg4iV4AXcitBHgD+Y9ROaFQg1cIMAfSEKAf/e1IaEfCf2QJC8u3goJ/Tt1TiChH1Khl1RAQj/u++AW3PeBC9z3gaS9Iwn3fST0I5QHcgKaCHCxZ00EoTwI5QGPIZQHuHihoTxI6Af8j8fBdOwJ/Y3m8tqL8vUsLW02SJYYdM/pYf8ZahTfcyli2yZ7+jTPsQronkKR2Dns9EGapf/fzL5w65ussFqAL6U3Dtwxl0p79D0RKpW00Vkbsm2NFDDNPD/VYjzeyunff4xa7HzMcFLGjLd5DiiyG5HdiOxGZDfCJAr983iu5TCJnjQuYBKFSRQ8dqCyFybRk8bFqZlEdyK0Ee0I5j1E5oVCDVwg2hFIQrRj97UhuxHZjZAkL875jOzGnTonkN0IqdBLKiC7Efd9cAvu+8AF7vtA0t6RhPs+shsRygM5AU0EuNizJoJQHoTygMcQygNcvNBQHmQ3Av7H42A66ezGDbIFGz/3V3zi72TSCm3CU+kN5mlRRXPyeZShJjKioWPbjJB+57GT+UpWvMhy73EomKUsjxLmNxGhta8XiodMZPYeIU2SfiM0fS6ynFbZ6mDaqmEKHiMcisdzV4Cd5qRxAY8RkHS0HqO6o3g+LLw28NqAV6ENABfw2sBrAx47FB6D1wa4gNcGXhvA/1m8Nn3PblSmW+qPynSoTNepMl1N4Qyk3e2U8ki7w6nb69Q91rS7Hunq89rLe47a2BLhoNhAsYFi87yKDTw+sDoe6UEPjw9wAY8PPD7gseORvfD4nDQuTs3jsxOhvcWbOVxP4MMDTBiCaRymcUiFw5MK/U3j7Xl5RbrdLkuz9i95084bW0qJAiMcPiO0yLJlGBWMUkJA2zm3ra9ZVmbc4QGqNPO/DW+Z/43iAHf402cC3OGBi/53+HYXU++Up9L5vXirrzxaFo9ryPSFkYxTS2hac6W/CE1Wf4npwSstZZOhxuxeSG4IvoUERHDbQXNbmyqyJR1ifeItLPR9jsliZtuEhSQ3+Wjzjl87+6Uo5+EbVKeJFxMFFLgDl6UBp9gnL+IqYtqfuANX2R32FP+DPEnMn9iW+a/SmBiK1jc9gbkNj2REmpkvfdeNsNC4Vv5dmb2zu1h64wbBvtvvbu+LipJ+T7mkwFsgwpKQWKzSUg7lOP/rxeVbO5iFS/8FlQY1DypD9lhh8+C1qLi2La7NHEWJG0/5kmI1Edv5QHun2Jim6jrzhhc2ykhStrjKUdM6x1tbHOeWWk6kvLqK8/MPylHkizhwuCYrB+Kuoqq0rv4yMRtEsTvqP0Z92I5lP5EkXXUASVY4itgLKGJx1+CxggidNKP3PKTPtnlVA7S/WzJUiLJSsjzwQE9asHD+FxNeNiF+N2lB3E8X57NpVzDi7HF7iFSuIP0mJrEXCJprOiLW5WJUqwfgEbujs7zbLVO0SsGaiwbzPN9uL6Rx+WUbyhbZ5loka7RepHpb+yXaN3aAXeKUNeKudomcnBvekrDbe/ZJlJWMVi2j7ojNj+jref+aAyM7fBsLqBX9q66H8p2nky7L/Fmk6/ziYTfCHSwUFFSaSfNvSbO/KODZA5EY6qVh6AmDQ19EeZ8crjaOe/Z332sIhOKxsAmCXYGL3QZcGYtlB1NC88VsedSKWbTnxWXhZtiuWGvKap6WxHZxZ2vdQqVZPSmKCWQax/nelST6RjxnT4ANRxDJNk0P+emzkdtnNkYJNC1+g9JmnC/U0bWlbBVR7PHY80VAG5ErlrNVqXpMzKcu46NEJrOkhKRPsWZ3FWv/fCUJ06bEqTt0R6Pg6WI6Gp0t/FGB1eXbs8vLs8vLuuUWM3li7GnJxuNK0lzttdbcVRVVhPMylYqyw/mo3hpdoHac8PHSc5FQQV4WRjqqHGUhukTqNRJtuXKKs/0H5ZS7zqqtL9jOtp7dOHvPdVOEeaBm2YqZ2eJko1Qh5o+Jhdehf7l7zPUn07zMd53cO4nkEZOPHpL/Vw+L5H8k/yP5H8n/OLFgDwUukPyP5H/w2P55DIkDwAWS/3eX/N9XWONramBeKNTAxaEKdXxN7UUjaQ9fU6smpzSjo5jYHtN9Q//q36J/2YK1NKE5yZ6rYu/zlTpe+uwz6iBB5qAOUh3pUAcJdZAgFU7xEwGwDIBbYBkALg4CF7AMAEmwDBysZWAL3ou+6gbCgyBR9i5RoLMAFwgPQngQeOxYZC/Cg04aF6cWHoSvwQP+x+OKesavwbZ/K2DJmdv2gdvFdLHW/BpbpG1W3LNuu8qJ+U8jN8sNGrnDJxYHw9Hoy8106paGMFlPvJJu1cA5k8dE6AkpXlMSIMt4Crhff9+dFw/yEsGrFoyiBTfTGdza26wXkGY8rG9q1lGT8jSds4LpTb427OwtpZTVlhTYWBeu3MR7y8nt2m9Ka9ql3YMLtZbJ40MqHf7h2hgvoDef/gEBmwVwsct6/OvtY+/q/VeFMK2e+6UHHY3mJbncqc09SbWqxtNS8Zr6qtjlNRbVrjY4qXwRj3mLoaQLOdaugvUrBc67VOuM2k1lu1ZUXGoqlpgVDrf1kAu97GDO8w7QQuGB1cOi8AAKD6DwADyL0MagpQMX8CzCswge2z+PwbMIXLwEz+JOhDbSC8C8h8i8UKiBC6QXAElILziq9AIUHkDhAcicQ432QuGBnboxUHgAUqGXVEDhAVgGwC2wDAAXsAwASXtHEiwDKDyA8CBIFOgswMXR6CwID0J4EHgM4UHAxQsND0LhAcD/eFxRx154oNGwXntRvp4lxc0GyZKN7jk9HFN+HMX3XIrYtsmePs0zvAK6p1AkdjQ7eZBmBQ1uZt8B9k1OWi0rLKVhDtwxl0p79D0RKpW00akcsm2NFDDNPD/VYjzeip7Qf4xalH3MEFVGl7d5riqyMJGFiSxMZGHCzAqd9rB1WphZgQuYWWFmBY8di+yFmfWkcXFqZtadCG3EWoJ5D5F5oVADF4i1BJIQa3lUsZbIwkQWJmTOobq+kYW5UzcGsjAhFXpJBWRhwjIAboFlALiAZQBI2juSYBlAFibCgyBRoLMAF0ejsyA8COFB4DGEBwEXLzQ8CFmYgP/xuKJOOgtzg1zFxo8iFh9CPJmkRptEVXqDeapV0Zx8HmWoiYxo6Ng2I6TfeexkvpIVL7LcexwKZinLo4T5TURo7euF4iETmb1HSJOk3whNH9UsJ3W2uqL2ZMKCFwrH5/HcKmDROWlcwAsFJB2tF6ru2+nzYeHfgX8HvAptALiAfwf+HfDYofAY/DvABfw78O8A/s/i3+l7dqMu3lJ/1MVDXbxOdfFqynYglW+nlEcqH07dXqfusaby9UiBn1eT3nN8x5YIB8UGig0Um+dVbODxgdXxSA96eHyAC3h84PEBjx2P7IXH56RxcWoen50I7S3ezOF6Ah8eYGoRTOMwjUMqHJ5U6G8ab8/gKxLzdlnutX9xnHbeePbkKbDM4bNMi9Rb3vuCpUoIaDsRn/9LnpW17fBQVpr534a3zP9GcQC7wOmzC+wCwEV/u0C726p3GlVJJ1i0FFQeLYvHNaT/wkjGUSY0rbnSX4QmqxPF9OCVlrLJUGN2LyQ3BN9CUiO47aC5rU1peXZtY30yL7zS+xy95ZkNGEKSm3za+mAIlP1SFCjxDaekiRcTBRS4A5elAafYJy/iKmLan7gDV1nUeIr/QZ4k5k9sy/xXaUwhReubnmDfhuc0Is3Ml9PrRlhoXCtTr8wu2/0uvXHDYXEo3zHfF70l/Z5ySYG3QK4lEbVYoaYcnHL+14vLt3YwC6z+CyoNah5UhuyxwubBa/FzbVtcmzmK8j6e8iXFaiI2kR9tIFiI9mmqLDRveGHjpiRli6scdK1zvLWFgW6p5TzMK8s4P/+gHEW+iAOHa7ISI96++Cu9QX+JnA2i2B31H6M+ZMkyqkiSrrqKJCtwRewFFLG4a+BcQYROGtx7HtJn27yqqdrfLRkqRFkpgx54oCctqDn/iwmtmxC/m7Rg86eL89m0K1h29rg9PCxX5H4Tk9gLBM01MhHrcsmu1QPwiN3RWd7tlilapQjOhYh5nm+3F9K4/LINxZ1scy2SNVovUr2t/RLtGzvAfnLKmntX+0lOzg1vc9jtPftjyupIqz5Sd8PPD/Pref+aAyM7fBvLzBX9q26X0lles8sLBoquNhxJSfhoAtoXjBu9bBu1izXPzEziWw2yp9k/9mYyEYGNVbaswYzUds9KJqazp+I//h5Mz8ZpGHrCMIcieW9Z78uTPViG7kTrRA3PzhSLg1vx/TW7VRGTOnx87YvInd6YPn4quYlY//JkIXCV8H+Q+c+b8uNrf0JRxp/lRgVtsh8GLo/NtJm3eyHI2r1yTF/n6uPfnX/Qo42oNn+zVE+E5H9YZe+18+rVv1KlnVtyeOzoCTkZZp2Re5XwP5uOjyLNpIzHEu59o8eR++qVO9Om3KvyeIYsdu3u0P2/fIDRSI1G1/9h9+k3JeJf6feUlH4ngse/zfjpyc3p6s1V5DeZ5cwduh9TbTjNyR85bxzT2EZ+K+eBHMUeHMXvYj7mvnnOY8P5yr6RL2KzSbN4cB6PhaVjjpeZW2Lg5q3cofvm9fnr82Vqxs6HhGJDweuEfDuXeeToCdNO1vaWlCXh1bt83y3BDeEfhLSR7A9cTyxBnRLEnESKO8miiGkTQRk+vnYzNSgraGlUeu5TrLIrb0b1j1IkkpNm8tESNhFKR1llzrxFwQrO+8///Kfz4ZfFd3qa6Vru0H316tf80uh8JBlxZUn26tXQ+VoeyND9Q/zVEbLy+1UQ8firO+d0Td/1WRIybm8TudjPmOtLxX47cIdl9jIiM+evm4E7EUqbDk9PRrn7LMPp1Pz8e0rSckwuO62g+fLkBlyZv4P8tGp42T/N3vVHxyTtfOXBV5uyM6HStjgPE+7bzXIeDKq0cJJUz6D3etXLzjg0NuyZ1zN13YH7zTCwW3nZ6Y3Vui3zmhfImvycLfPPn8xAxRClzIYzw0XudDDrceX7lOjGtjclUffx8yd34N6KwEqUSASmi2QP7sD+/9AduSOzYpFkaRTDp+z3Jzdk8V1qb2BuNqz55/8B/KiDpQ== -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment FULL ON

- - - - - -**Required Permissions**: `Experiment Full On` or `Experiment Admin` - -## Request - -

Path Parameters

Body

required
- -The full on variant and a report of why this experiment is being put full on. - -
- -A JSON Object with experiment data, the experiment note and an array of errors. - -
Schema
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • new_experiment_notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • experiment_note object
    reply_to objectnullable
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • experiment object
    application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • experiment object
  • ]
  • preview_variants object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment object
  • ]
  • alerts object[]
  • Array [
  • experiment object
  • ]
  • sample_size objectnullable
    experiment object
    variant_screnshots object[]
  • Array [
  • experiment object
    file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-get.api.mdx deleted file mode 100644 index 5bf42ccd..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: experiment-get -title: "Experiment GET" -description: "**Required Permissions**: `Experiment Get` or `Experiment Admin`" -sidebar_label: "Experiment GET" -hide_title: true -hide_table_of_contents: true -api: eJztXV9z2zYS/yoYvLTxqbYSZ653enNv2l6v0yZTO/di+2iIXImISYAFQMuqRt/9BiAlkRJFSpQUy8pmJhOGBBYL4Ld/gMVCExqA9hVPDJeC9ujZ2R/wZ8oVBOQjqJhrzaXQZ2c98vDjcwKKxyAM+RnMA5Gq9O4qiLl4oB2aMMViMKA07d1OqGAx0B6FeclfAtqh3DaWMBPSDlV5i7RnVAqdJY5uQiAPPHggckBMCGRBiIxC7odkLFMyYsKQgBlGBkrG57RDtR9CzGhvQs04sQxwYWAIinboQKqYmezV39/TDo254HEa097b6fTe8qMTKTRoW/tdt2v/KfN0Rf5z/eF38qH/GXxDRtyERbYsH5YFXwoDwtjqLEki7jNb/eKztjQmqxxKR86OoJIJKMMzDhaUm8vyoLLH8MziJALbwU4+IfNS2iguhsVC1IA2XqHZaYdyA4plva+gXxjADtWGmYYGVCqEfTe1k/0EkUxsOx4zVdXm0xUwA98ZHgPtUJFGEetbYhYzWatqVwoyaU+g0D37YdqhgzSKPClyksulN2iiQOOJKc5EHaGKyeh2aMyes+fLaYdGTBtPAwiPC8+XAew0XELNuNLVmJg3XcRHYZgsSwkoH4RhQ9BVnCTMGFBW4u7ugsm76d3dxdJDCVaX7y8uLy8uL6vYXbTkyYFnFBsMuN8gLN2uhQVAUDtKfT7kmZDkVL0tqvgKmIFg85ko1OmPmxUCU37In0rs9KWMgIliTwcs0naQ2BMzTFVRXRnPrKg34BF4aRJJFnipiurF/sJXMvmkoou33e7z22734u15kmmB3YbBSzUob43uK+mmABKmzJIureD0N6YeweQqCmLGK3s25ysrMbUQ4MYR+KRBtWUyTYLtBqNiemY0ECPHj5HFXG3IZMVQl/yTOq5vQq4Lzso3mhSrWm4EN15Wv5W3sZGHMevndpwD4YG2fqBMFbEk9EFxsSKK7Wx49fQ2mHFU869KhLcZ/2J1wc2NLV6Uu3U9LDnxieIxU2MvBqNKfsyWojqULGps8PvuRkJ9w2MgRpIfpHzcWrJZLFNh3CLPkunDQCogjPSlfORiSEKmSR9AkJgFbryWVFQFWdc3S80z0mN+yOEJZusZGAzsMFXVFxZFtzSRmhv+5KwrDFn+mIpHIUeC3m856TMUedqoeq4nU6fVtM8i2AQH4HNdHmGRxv1ySTt/TyxKwdMyVT54OTjG9azQ6RxGY6sCDDTwfmAZL/X8JVWzRdYhzWOSKj9kGraSoiti2SIDqYhRzM+kRo5IzMSYzChqwhQ4GSJSEPslN6eFHYo9WFW0WMdusdp5QLgYOWlc1M5dLdOrw73VPBo2LG4AMaXYmLpdx1g3Y2a9EzPX1dTnyk8jpr79WbLoDc09H8OGtRVtgfaKvly5Ss/rsR/KSA65z6LejUo1bgqduoy92OoTcXHUuNij7rWaq0adlnWh/XvDhm9KHOUvV96V3gOLv7TStm2urWQ/tlfW8GxDDXOemhcBzW58CRio1E9YeNGhRlwcWKln+92t1W09JjVUzjki6WiQNN3I+C0s5g2w+A1domJfOtKLAFAtpIpHTxakF4d+3tAiqS15a+pQzveitTn3W/k384HItsp3EKGMwFqGZ1vxi+Z/c2829Ftqpi6jk3e/8H4+ICW3bfZSjsROGqN24Yya5DVrkhpjsISmDxZE7m2j+KzifpkY3Xmnp/VOSySzve3ev4EFZYfttOLGq2ojX67tqg4atB/6F69cK6wAZyH6O670D2s3cb2P0oLrfcTFUeAC1/uIJFzvf+H1/h4iDW2dCDzKg3rixfUEeiKICzzKg0d5UMZei+7FozwnjYtTO8qzJqCGASaE/xEGmHZaNZciqFtzlJOrC9Gui+Vm7+lKaldjLsw7m9zD0oCD8CvXosUk+skdzfJ47mhvwkTQu7u7vZ9OaYGEzVDipdSoGskJx4k0IWhekb6fZScF3K9e79om3Scvkby8L7EowW1zFrduNesFYBiPqotaPirSk6ZzUbC1wTdWnL2V9K/K9P+dfeHSSry1ntxkV6bQ0iF3M7jUW21kfEgV4R+u7ZYEesOnr/ZxJwJx0d4bbg7BbjePG216VynUq4UyLVvzwgdaamAt0gt6eaMyT6D0uluWVq6Pqdw1L/Ho8n5XLunZ0v74Ugx4w/bHJsOx9T1Uf0BAfkiNyUa7cAfSeniX7zyqHKD/5nSm7nIfX4pg4W0d2EpvABhM6F9PFhP6MaEfE/oxCog+FvreiAuMAmIUEGXs5WUMo4CIi68hCngQpY0H/FF4j1F40aFGXOABf0QSHvDfnDdM6MeEftQkX915K0zoP2hwAhP6USu00gqY0I/rfZQWXO8jLnC9j0h6cSTheh8T+vEoD+oJ9EQQFy/sieBRHjzKgzKGR3kQF1/pUR5M6Ef4v54A02tP6K/dLq9cKF/P0tJmRLLEoCcOo5fPUAPxxJUUrkz2dTLPsQrgCSKZuDZc80Gapf/fz37h1rdZYZUAX0lv7NABV9p48JxInSrYydZGbF+UAmaY56dGDgZ7sf7taVRi52OGkyJmvN1zQDG7EbMbMbsRsxtxSxT9z9ezLMct0ZPGBW6J4pYoytiR6l7cEj1pXJzaluhBlDaedkThPUbhRYcacYGnHRFJeNpxc94wuxGzG1GTfHXBZ8xuPGhwArMbUSu00gqY3YjrfZQWXO8jLnC9j0h6cSTheh+zG/EoD+oJ9EQQFy/sieBRHjzKgzKGR3kQF1/pUR7MbkT4v54A00lnN+6QLVj7c3+Ln/g7mbRCl/BU6ME8LWpRHHweZ6iJrWrYsGw2kP7GtJM5J2s6slp7EEnmRpbHCfPrBqGxrhfJUaYyW1NIk6QdhbqfiyymVTYGmPa6MYURIzSKr2etgPs0J40LjBghkl5txKjKFM/JYtQGozYoq+gNIC4waoNRG5SxY5ExjNogLjBqg1EbhP8Xidq0td14M91KfbyZDm+m2+hmuoqLMzDt7qAjj2l3aHVbWd3XmnbXIl19fvfyC5/a2NPAoWODjg06Nl/WscGID+46vlJDjxEfxAVGfDDigzL2enQvRnxOGhenFvE5iNLe48ocQ08oh0eYMIRb47g1jlrh+LRC+63x5ry8RbrdIa9mbX/lTbNs7CklCgXh+AWhQZetwmghKAUENNm5ff2aZanFAxpQbZj/2Osz/xFEgGv40xcCXMMjLtqv4ZtDTK1Tngr2e3lVX/q0qh630OlLlGxQSxo4wMpFQRKNPSOrBm0+e/ZDp7aBxUC5XYSV/vwuDRSb82x3NttvWeKjNKo72S7mz2J+s5B0JgC0s3S1gjZM2X8VzJ4g4NkHmVjUplHkSSv/vozzOrmacBHt2fM9mq3TVk8Y9kNcHHjr2erNKhZWCtZdALNKFUZeUavWo6lJ2Te3sLGVntuLQt2lIdjAZFvrs85SZ5ZplUO0t2hvUa8et15Fe4u4QHv7Su3tgD1Jxe2c7OEqGxTIoxbIpk3tPXkY2w/eEqM/5ZgsyJYtwiJQ9b+l0M4Z3NdFd+5Nwa2yqE4TTwAEEFjnKA04CB+8mOuYGT+0vpSbYU/zv8BTwPzQlczfKhusXpRu60jtw+jGYFjADNtACVfqmys7d24WCz2uUYZrpvDFELqfUVTwZ8oVBN7SIKwoieX7PotJAd1/vrt874g5uLRnaHWJsSDZgsN64pWouHYlrm0bC9vtaV+B0KHcRdabQLCUZVHnNswLvnP5Kgoy5kqmprGN9+6a1T40WKT8nk7yr2800eBLERBuwOkBsamqKvDVXidmRDQbQnsa1QkgTvxkkmzqAyhwylEKL4CYiU3TkBaDsFFg4ScewSdXvOwxufduGEqDslazjHhgwgYsdP9hE5VC4MOwAXHfv+vOml0jiLPPzck2uYP0WYbCCyTMPR0pTPFa4/UEeMyGcJFX6zMN6xysuWqw3/Pp9iIYFDtbcwGuK263GDYvvTzqTeVXxr62Am5dnLJHvOnWRT6cO66ScLZf+HRb0clo9DKqTGxuoq/n9SsMRmZ8a6/iXtQvH2IrrXncH+d8hzKwqb7gEMWssqMXhdj5xWTxn1+CqV1CgHpySL2dOD3co6Exie5dXGgmgr58Pmd9HTNlovG5L2M6vbd1/FRxmy57O3EjdpXwX8H+9774+doPIc7gXCy0GMTsRYdyYZvNjtouZXjSK2LrkquPv5BfYezSOe0zS00oFf/LeTzn5Ozst1Qb0gfCBTEhkGyKyR29Svh3tuJYpplQeizh3iOM7+jZGZ05H/SqSM8Oi+Od9uj/cgJ3d/ru7vpvbrK4GLiIwGwuZuecOtQOZcb32/PueXe1N4J8SEDYHlwn4PNBnmNKTMgMycr2QbsuXP2Qj7vrsO34SCqXxjriJnQdIoWpJYmSQ8XimBmbPhWNz2lmtbM76q1fyX0QOltNZb3+qGSiOBimxq5jidQmzi7bz0ssYEZ+/vFmuT+TmVtAe/Ts7I981UI+goq5tgOhz8565KFIBMwDkar07iqIuXig8zWdgWdzkUSMO1c2104ZmG9LB0E6tFeEM73v0FBqY4tNJtbz+KSi6dS+/jMF5fCZC7bTiLcTGnBtn4NcldZ079tZ794Qm5//wIMHl50fQmESyCjkvpsaMrLuuV0Jk4GS8fm63s1EQVg5yH+LgNIOfbSSQku9m947b9BJieU9K3Ll+5CYQuVC5vLFZ22XA/cFzWAncTr9P1LGBrE= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment GET

- - - - - -**Required Permissions**: `Experiment Get` or `Experiment Admin` - -## Request - -

Path Parameters

- -A JSON Object with experiment data. - -
Schema
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • new_experiment_notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-main-metrics-data.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-main-metrics-data.api.mdx deleted file mode 100644 index 38e68e5d..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-main-metrics-data.api.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: experiment-main-metrics-data -title: "Experiment Main Metrics DATA" -description: "**Required Permissions**: `Experiment Get` or `Experiment Admin`" -sidebar_label: "Experiment Main Metrics DATA" -hide_title: true -hide_table_of_contents: true -api: eJy1V9ty2zYQ/ZUdpDNNVFpy0k4f+KZcpuNmEnti50lSpRW5EhGTAAOAklmN/r2zAClSVtI4E4dPIC57OdhdnN2JlGxiZOmkViIWg8EH+lxJQylckSmktVIrOxjEsHhzV5KRBSkHf5FbgDZHc+O0kGohIlGiwYIcGSviyU4oLEjEgg47L1IRCcnKSnSZiIRpNIrYmYqiexbdZAQLmS5Ar8BlBJ0gcBk6qHUFW/R/BAVKBQU5IxMLejUUkbBJRgWKeCdcXbIlUjlakxGRWGlToAtTf/4hIlFIJYuqEPHz/X4WDCPrXuq05vOndnWugtOwkrkjc2rHsh7CxQpUu0OqNUgLrdt8QMEirNkFJKhgSYAKqChdDXr5iRL3BZwSrRwpx6ZhWeYyQTZt9MmyfbtTxw+CSqNLMk6S5dVG8bc3Wloz7P2daAzWfJ2OiodLmMv0e+8jEnSHRZkT300kWCg6bXpirGNgRSRI8YkJh1gklHZzqcSsd76d20dig3lFD/GnE36QgktboHF5ffYJNxgi48ymt2Lf+/jSbKmVDVpenJ+fBtIY/r6+fA+XHjLYSpf5EEoqYzjIg42n0f+rPYqyIXBABtwhQwsuM0TQ4R/BVC0SnVeFeo8F2UUEze9NXZJdAKoUFkZv7WIIRxs5WFGBx4btCGBY2GYyyUCmpJxcSWonpioctoCG2k3KW+/FT2aTWaeiUf5QFSyF78QDMlUpOvyicO/Hfal+0Arl7MHmaIt1D1DwolfaAGGSBW0nF7BBI1G5BvzgEHDBC76ntJKKUsBg90rnud5KtY6naqqePHkCXG3XVY4GXgXI4sGA185g0YhewJmX3fyGkucyLh96CyGQlmSH8PQ8gucRvOCy/PuzoZexksa6Od2V2laG5niQlqKjNqL8Jmg3hVl5cI3BLWSeS0uJVqkFK1VCQKVOsqAkx2/r4D0/oKJS0s0TXXVwqKpYkmFJvGYDLBluCJZEKqjiyqqPNA073F/XCguZnOIebn/+y64ZyHTfKj3KyNa1JloOaStTXlkcnR9+TfK8IFSteB4/puwNmuPoSR5JcOmNbGWXZ49osyxKTNx9wMPsY2qYJ3Ke6y0dEPI/sNSVSls9iVYrrjwJAT9RZoN5u/RzDKrKsjPI//xcg6YqjuMEK36HpqqrYPyw1JDogvUAQipXK/IXoU3qCQ6GsqkVQS6t4xK31BsawgVXRVmU2jhfrTRUlkJ1PnpRQkl2ui3tdbBTpXTXeeuraUfvvKyhN3rKT/sj0Z+eXQ8nAvyy996v7zvIb9MDTnxtPtQ+0eMYBblMp0yotfUOMq+Oxah7q+xo1yfg+1HDGkb84jFJJrNpCXtlchGLzLnSxqORRZUu9d3wQHeGiS4Es2NLSWWkq/2hj5bMuJRviX9n/eVrvocAUX9T52aYaFqCjDD1XPA+R+KzML66gLdU+2eZx1i5TBv5r7/5IQwG7yrrmDw373oglDAV41Ke8cFaV2ZeWTJzLOX8luqpGAyYJoYmZdyX1/YOvPBPI2A6tdPp9W/+GjnQPnQdwpuWGR4x6o4zT47p7/M+iW0pacdIJ1/nl7P9jNVLtdIeRuk8H11ickuKeyu+yQDb8+H58PwUTAWXJSkG8LqkRK6a1Amv6IFTeATHLxsrPN6M+1abW+5gfHVhPHuUyDLfXBssCnQywTyvh02iYsKJuo9ELhNS1sPUgH5ldGkkOTS1x5WDuEDV29HrMt8xQ3vXNFavxzfj+97turrwGM1sE6SO7tyozDG0DT5Ddk2aTXqtrRWRiO91uk2m8QhDJ5JxlsYTsdst0dJHk+/3PP25IuOzh6PASFzytU52IpWWx6mIV5jb+/1x39+nrbvP4Ee75i/63WasqttIFbEQkbjlhD7u8PezfdQmMzsRtrwKpp5x0eyJOCnf+6g9MU4SKt3/7p31CuDV5fWNiMSy6dgLnfIZg1tun3ErYjEVUzZZe/h8ivr5nchRrStc8/4gl7//AM9qCyI= -sidebar_class_name: "post api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Main Metrics DATA

- - - - - -**Required Permissions**: `Experiment Get` or `Experiment Admin` - -## Request - -

Path Parameters

Body

required
- -The parameters to filter the main metrics by. If no filtering is required then `filters` can be an empty object - -
    filters object
    segments object[]
  • Array [
  • = 1`"} schema={{"type":"integer","format":"int64","minimum":1,"example":1}}>
  • ]
- -A JSON Object with the current values of the experiment's main metrics. The object has three properties, -`columnNames`, `columnTypes` and `rows`. `columnNames` is an array of strings which identifies which -columns are which in the `rows[][]`. `columnTypes` is an array of strings which identifies the types of -data in the `rows[][]`. `rows` is an array of arrays which contain the current main metric data for each of -the experiment's variants. The column names are defined as the following: - -### **Regular Columns:** - -- `variant` - The variant that this row describes. (0, 1, 2 or 3). -- `first_exposure_at` - The date of the first exposure of this variant in milliseconds since epoch. -- `last_exposure_at` - The date of the last exposure of this variant in milliseconds since epoch. -- `unit_count` - The number of units that have been exposed to this variant. - -### **Dynamic Columns:** - -- `metric_${metric_id}` - The current value of the metric with the id of `${metric_id}`. -- `metric_${metric_id}_mean` - The mean value of the metric with the id of `${metric_id}`. -- `metric_${metric_id}_var` - The variance of the metric with the id of `${metric_id}`. -- `metric_${metric_id}_pvalue` - The p-value of the metric with the id of `${metric_id}`. -- `metric_${metric_id}_impact` - The current impact of the metric with the id of `${metric_id}`. -- `metric_${metric_id}_impact_ci_lower` - The lower bound of the confidence interval of the impact of the metric with the id of `${metric_id}`. -- `metric_${metric_id}_impact_ci_upper` - The upper bound of the confidence interval of the impact of the metric with the id of `${metric_id}`. - -:::caution -The columns may come in a different order than the one listed above. It's important to use the `columnNames` array to identify the index of the column you want to use. -::: - - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-main-metrics-history-data.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-main-metrics-history-data.api.mdx deleted file mode 100644 index 90253f3c..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-main-metrics-history-data.api.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -id: experiment-main-metrics-history-data -title: "Experiment Main Metrics History DATA" -description: "**Required Permissions**: `Experiment Get` or `Experiment Admin`" -sidebar_label: "Experiment Main Metrics History DATA" -hide_title: true -hide_table_of_contents: true -api: eJzFGNmS4zTwV7q0VAHBk8wAxYPfskDBQu1RzPKUhKRjt2PtWJKR5GRCKv9OtWTHzhy7w7XkIWVJfV/q1kHk5DIray+NFqkYjX6h3xtpKYc3ZJV0ThrtRqMUVt/f1mSlIu3hB/IrMPZsb5orqVciETVaVOTJOpHODkKjIpEKOkG+yEUiJDOr0ZciEbblKFJvG0ruSPS2JFjJfAWmAF8S9ITAl+hhbxrYYVgRlNJ5Y/dgirFIhMtKUijSg/D7moWQ2tOGrEhEYaxCH7e++VokQkktVaNEenU8LqJM5Pxzk+8Z/75IvZbgDRSy8mTPRFjvx2e6FVg5SkRmtCftmSjWdSUzZKKTd44pH+6LbNbvKPNsVmtqsl6S49PI0H0Y0NGGbTWERGtxzz7wpJ5OYSnzv2rJRNAtqroitmoimCh6YwdknLdSb0QiSDPGjOMiEdr4pdRiMcDv9o6J2GLV0FP06YmfqODaKbS+2l+8wy1Gn164/EYc4y8RHFwmf5+IVxyzVxzEVzv+e3ku6FXOQvo/lqYoHPkHbXaCvuzYWnK10S7q9eXl5f2gm8JP169fwevgJNhJX4JCqUGRtzJzp7iryUJUYgwcqNGrUKIDX1oi6L2bwCozVaP0K1TkVqfl231NbgWoc1hZs3OrMcz1GShIB6ghWJ4TMxrJwa6UWQkyJ+1lIanbiKgO0FIHokOyBPKzxWwxZNGyfyoLpsMWdgyVo8dHiAdN7lINH72Y2mOLHAjdLzlbtBK1d2C2ZLn2WHBUUeYpP1l9rtnuURfg8hcVz6mQmnLAKHJhqsrspN6kcz3Xz549A669m6ZCC99Ge6WjEZ9dwCpHTyu4CA7l704ya3afupPSjjKjcwdO6oyAapOV44DeSt1RaJexfvpSOqYDMdzW5Mbw2WUCVwl8yTX+q88jjUJa55d0WxvXWFqif0ieAAQdUNyV7sSwtW3WWBvqt1TUWo2PlKwq+agOFX6YPcP8N9wbLf0yM01vRN2oNVlmwmcuGnNHlqIAlPO98ET+kUfWqOV9Plmjmgq93P4dlhivRdJ5Z6KHuXcB+N1eo5LZ/QCMVWb5yaH9kPmxj6aqOXkgHsfyxGsZGK/O8T5kiAeYLRWh7jjy90diu0V7njXZf8+zDqp1bOuLj6OpVDVmp6iLq4/EdJnJZWV2dDJ1WMDaNIO4Nbrgop8R8D1qt1h1Rx9d1qaue1nD4n+Tda7TNM2w4SZheO84ULiHzCgWARByWRQU8I3NQ6eKkazRBJV0fH/h2mxpDC/8p47lNNaHS8JA4yheqGctQLxDvenu4n1UQed02xsi3IF9ix5ojYPQc+70/qVueCDX0/tCbrsGDcdfQ+Rm4gkYj+3HSt51nUxQkS+57xS1cUFBno1SMel7Dzc5DIeo46Tt/CbcBk7a9o+nHrLbbvhqbCVSUXpfu3Qycajztbkdn7rgcWaU4HHHUdZY6fcB6VdHdlrLn4mXi+HxNfsjmmoI1KsbN9rxriTMQ7t7t5FlXJi+eQE/0x4KE7+x8aWx8o8QAWMYjV42zsOauviPcwbMxbSWF4zIzdeycWSXWMvlDe3nYjTi6SEOnNMhvW4Y5IPfWgLzuZvPr78I7uSA+6Uf+b7v+vOzQasfpWbnU9HVcLbpJpV+UJk9PnYsjovBzBGnisHocHlkUxYmmFj6MF+sMbshzYDs5WjSq/Hl+PK+oTW8rkmzca9rymTRplfsG07tXrDu9HkrYfAF+2Rn7I3Um1icQqM7CEUeIjYWlUIvM6yqMOuG9jnjZD4mopIZaRdM2DrkjTW1leTR7oPNOdAV6gHE4DXhJffhL9vR5sd2tPlu+nZ6V8tDX0P+jceLNpA93fpJXWGcOEMWHdqUnA2eMpxIRHrnZaPNSv7CEAZdZi4SUXJupzNxOKzR0a+2Oh55+/eGbMg1jhkrcc2Onh1ELh1/948Hj2r+Waf45/AP3kseVL5Lbb3vQlqkQiTihjP//FknBHOb9Sx/BPk2SnnBVXZA4l69PyYdxjTLqPbvhV0MKuab19dvRSLW7VuNMjnjWOTpnP9TMRdzFtkEy4VcDvsHUaHeNLhh+EiXf38CiT26nQ== -sidebar_class_name: "post api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Main Metrics History DATA

- - - - - -**Required Permissions**: `Experiment Get` or `Experiment Admin` - -## Request - -

Path Parameters

Body

- -The parameters to filter the history by. - -
    filters object
    segments object[]
  • Array [
  • = 1`"} schema={{"type":"integer","format":"int64","minimum":1,"example":1}}>
  • ]
- -A JSON Object with main metrics history per period. The object has three properties, `columnNames`, `columnTypes` and `rows`. -`columnNames` is an array of strings which identifies which columns are which in the `rows[][]`. -`columnTypes` is an array of strings which identifies the types of data in the `rows[][]`. -`rows` is an array of arrays which contain the data of the experiment variants over your selected period. -The column names are defined as the following: - -### **Regular Columns:** - -- `date` - The date of the row's data in seconds since epoch. -- `variant` - The variant that this row describes. (0, 1, 2 or 3). -- `first_exposure_at` - The date of the first exposure of this variant in the current time period in milliseconds since epoch. -- `last_exposure_at` - The date of the last exposure of this variant in the current time period in milliseconds since epoch. -- `unit_count` - The number of units that were exposed to this variant in the current time period. -- `cum_unit_count` - The cumulative number of units that were exposed to this variant at the end of the current time period. - -### **Dynamic Columns:** - -- `metric_${metric_id}` - The value of the metric with the id of `${metric_id}` in the current time period. -- `metric_${metric_id}_mean` - The mean value of the metric with the id of `${metric_id}` in the current time period. -- `metric_${metric_id}_var` - The variance of the metric with the id of `${metric_id}` in the current time period. -- `metric_${metric_id}_pvalue` - The p-value of the metric with the id of `${metric_id}` in the current time period. -- `metric_${metric_id}_impact` - The impact of the metric with the id of `${metric_id}` in the current time period. -- `metric_${metric_id}_impact_ci_lower` - The lower bound of the confidence interval of the impact of the metric with the id of `${metric_id}` in the current time period. -- `metric_${metric_id}_impact_ci_upper` - The upper bound of the confidence interval of the impact of the metric with the id of `${metric_id}` in the current time period. - -:::caution -The columns may come in a different order than the one listed above. It's important to use the `columnNames` array to identify the index of the column you want to use. -::: - - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-participants-history-data.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-participants-history-data.api.mdx deleted file mode 100644 index e2c7d620..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-participants-history-data.api.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: experiment-participants-history-data -title: "Experiment Participants History DATA" -description: "**Required Permissions**: `Experiment Get` or `Experiment Admin`" -sidebar_label: "Experiment Participants History DATA" -hide_title: true -hide_table_of_contents: true -api: eJy1V1uT2jYU/itn9JKEemFJO33wG2kzbZpJdie7eQIKwjrGylqSI8mwDsN/7xzJBrOXZNOmPDC2fO7XTzsm0GVWVl4azVI2GHzAz7W0KOASrZLOSaPdYJDC8vVthVYq1B7+QL8EY0/OJkJJvWQJq7jlCj1ax9LpjmmukKUMD5RvBEuYJGUV9wVLmG01stTbGpM7Fl0XCEsplmBy8AXCURD4gntoTA1bHt4QCum8sQ2YfMgS5rICFWfpjvmmIiOk9rhGyxKWG6u4j0e//sISpqSWqlYsHe/382gTOv/KiIb475t09BK8gVyWHu2JCatm+IBvmdEetSeZvKpKmXGSOfrkSPDuvsVm9QkzT1G1pkLrJTr6GvW5bxM6XFOo+pTcWt5QCjyqp0tYSPG9gUwY3nJVlUhBTRgJ5d7YnhjnrdRrljDUxDGlskiYNn4hNZv3+LuzfcI2vKzxKf4chR+k8JVT3PqyOfvENzym9MyJG7aPv4RRbRnxNRPHVLJjquHxlv7enRo6FmSk/7Iwee7QPxizA/V5p9aiq4x20a+X5+f3a24Cf11dvIeLkCTYSl9QCXqZyYpr77qyGwIVZ0wlFNyBLywiHFOawDIzZa30e67QLQ+v102FbglcC1has3XLIcz0CSlIB1xDCDc1Y4yMg20hswKkQO1lLrE7iKwOuMWORIcGCeKn8+m8r6JV/1QVJIfC6ohKcM8fER48uSs1PBzN1J63zEHQ/TGz4VaGGJsNWpo3FhyWmHkUEOuFdFHcoy9AIy86LjCXGgXwaHJuytJspV6nM30GS8E9LuEspIyeO93WbJ+5g1sOM6OFAyd1hoCVyYphYG/t6iS0r3Eq+kI6kgOxilbohvD8PIFxAi9pcv/8IsrIpXV+gbeVcbXFBfcP2ROIoCOKp9IdFLbRy2prw1SWCtu40Ccly1I+6kPJv62eaP4f7bWWfpGZ+hhEXasVWlJC31wM5hYtRgNQ0LR/ov6oI6vV4r6erFZ1yb3c/BuVPC471KIL0cPaZzpN04zXNEL6BepA8QYyo5Cs5yBknmPgN1aENcajU0YjlNJRofOV2eAQ3vhnDqSqjPWh1gzUDmPnncyK2GzedE3bBBqpBd4ebI7NctzfQdYwGD2jPfCDdmXPrqdvDRrKvcn0fYw0dZ7A8dh5LIhuJ5FAhb6grcQq44KDBJxSNjoOKTfa9RHWftRfDqN2ORAkQrvpkFltS5aywvvKpaOR41qszO3wsCOHmVGMsJDDrLbSN4Hpo0M7qeRbpNd5//MV5SOGqk90dDcetNivQC7CMry75ogXJpdv4C02kJv4zGtfGCu/hAoYwmDwrnYeVth1X0QhMGOTSp4RI03pRe3QLnglFzfYzNhgQNgiotFJX16HFOnD362A2czNZlc/hXRSwX044sHX3fY+gWFHoDU9xUzjPvLpcMwRxkwfByXz/byHSCLm6AGL8z2FMjchxNIH9LHi2Q1qIqQsx5COh+fD8/uB1nBRoabgXlWYybxtrzh+DlsjRHfyqrUw5IJysjX2Rup1xCFhI/ZKkdDG2nKluJcZL8sAhMOezaiZ9wkrZYbahRC2Cbm0prISPbdNiDkVuuK6R9G7alz2gc+fLd7+fXI9uevl7jhDfsTNpi1kj7d+VJU84tHQRbu2Jae9e45jCUvvXHv6XckS1vXlPGEFdXY6Zbvdijv8aMv9no4/12hDp1HFWMlXlObpjgnp6FmwNOelu3tp6vv9vHP7BfyHq9SDrneNrZuuoFnKWMJuqO9Pb3yhlNueJ/sjyW/RyjOasT0R96b9Puk4JlmGlf8q7bw3Ly8vrq5ZwlbtNU4ZQTyWE3Kn/5TN2IxMNiFyoZPD+Y6VXK9rvib6KJd+/wCE/VTM -sidebar_class_name: "post api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Participants History DATA

- - - - - -**Required Permissions**: `Experiment Get` or `Experiment Admin` - -## Request - -

Path Parameters

Body

required
- -The parameters to filter the history by. - -
    filters object
    segments object[]
  • Array [
  • = 1`"} schema={{"type":"integer","format":"int64","minimum":1,"example":1}}>
  • ]
- -A JSON Object with participants history. The object has three properties, `columnNames`, `columnTypes` and `rows`. -`columnNames` is an array of strings which identifies which columns are which in the `rows[][]`. -`columnTypes` is an array of strings which identifies the types of data in the `rows[][]`. -`rows` is an array of arrays which contain the data of the experiment variants over your selected period. -The column names are defined as the following: -- `date` - The date of the row's data in seconds since epoch. -- `variant` - The variant that this row describes. (0, 1, 2 or 3). -- `first_exposure_at` - The date of the first exposure of this variant in the current time period in milliseconds since epoch. -- `last_exposure_at` - The date of the last exposure of this variant in the current time period in milliseconds since epoch. -- `unit_count` - The number of units that were exposed to this variant in the current time period. -- `cum_unit_count` - The cumulative number of units that were exposed to this variant at the end of the current time period. - -:::caution -The columns may come in a different order than the one listed above. It's important to use the `columnNames` array to identify the index of the column you want to use. -::: - - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-start.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-start.api.mdx deleted file mode 100644 index ae0b0bcf..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-start.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: experiment-start -title: "Experiment START" -description: "**Required Permissions**: `Experiment Start` or `Experiment Admin`" -sidebar_label: "Experiment START" -hide_title: true -hide_table_of_contents: true -api: eJztXVtz2ziW/issvvR0VhO77dT2jN6crund2anppOJkXyIvA5NHFtokwQZAO26X/vsWQEokJYqkKMm6+Ouq3XEo3HjwnYODc+OzG5DyJU80F7E7dN+8+UR/pFxS4HwkGXGluIjVmzdD59s/vickeUSxdq41k/qbI2Tl6VUQ8fibO3ATJllEmqRyh1+f3ZhF5A5dmrf8Z+AOXG6mS5ieuANX5nO6Qy1TGiys6fOEnG88+OaIsaMn5BQDOY8T7k+cJ5E6jyzWjhaOMkt76w5c5U8oYu7w2dVPiZmfx5ruSLoDdyxkxHT26D/fuQM34jGP0sgd/jSd3mTLIaXfi+DJ9F9eDfPNP8x0mt2TY/6srovFgcMcX0T2X1o4d8JhoYjvnEeuJw63K1x8a1/EmmJtpmRJEnKfmVnOfldm3uflFxK3v5OvDb2lSEhqTsr29bOVztspLXl8V35vSyR34NJ3FiUhzZ9MB24sNNX1LZrazefxXfl9DSVIaSemR8dnYWge5OuY2v/M26pExCpb48X5+TJlr5z/uf7wm/PBvlZGqNIUAdNssEhns9qM2LHDpGRPBiMkpZDKUHhLFM0GLLWzUxkMa4rUMrXM6xaLbB+fB7UwnZP8J7Mvloma9sVsgFeadmrXJ9kCGorxS6gfGAC0bbxM49i+nmHQBwpFYubxmG7EWsA0/VXziNyBG6dhyG7NYAbx2axy0xFE0n+A0uuZH6YDd5yGoSfifMjF1h2mKI3xwCRncdNANZtxPnAj9j37+3I6cEOmtKeIYo/Hni8C2ohcsZytStVjYj51GR8lMpklJSR9ijW7oxrwG/GvNUnD0aNR8HwxHY3OFv6owOry3dnl5dnlZd1yi5k8Mfa0ZOMx91uY5fzcwIIoaKTSLb/jGZPko3prdPElMU1B950o9bl96iDCpT/hD5Xl3AoREovLbzpmoTJEYg9MM1k36hI9s6bemIfkpUkoWOClMmxm+zNfiuSLDM9+Oj///tP5+dlPb5NMCmxGBi9VJL0Vsq8imwJKmNQLsrRmpf9m8p50LqIoYrz2zebryloYYa25tgN8UST7LjJNgvWIUbM9szGAkcPHSLFXHRdZQ+qK/tO06s8Trkp6zw/KKXc1q4m59rL+vbSNThrG7D3XWzk5PFBGLxOpdMwQaqe4WGLFfmd4/fa2HOMQ80fFwuvQv9w95vqzaV7mu1VvWFHiE8kjJp+8iLSs6DFrsuqdYGHrhD+fd2Lqzzwic117L8T92pzNIpHG2l7MzTC3NBaSHObcCnFvrogTppxbotiJWGDptSCiaoa172ZG87TwmD/h9ECz+wyNx4ZMdf1jg6KvbiIU1/zBnq50x/I/0/g+Fo+xe7Pmps9Q5Cktm1f9PLVSTfkspC44IJ+rKoXjNLqttjT798DClDwlUumTl4PjqXkp7nQOoycjAjS1rH3HPF55832KZoOsXR6PSSr9CVO0FhddOWZZzlhIR0vmZ1wjHp2IxU/ObETlMEmWh4ytyfySH6clq8YWTlWcWId+YvXTgHAZOWlcNO5d46KXyb3WPmp218UqugIzq5WYuax2fS79NGTyL/8lWPijm2s+mt01djQN+gv6auc6Oa+e/IkIxR33WTj8LFMFo9Cp89jebp/AxUHjYouy10iuBnFalYXm/z6zux8rK8ofLj2rPCcWvbTQNnOu7GR+7C+s6btxNczX1H4JaFfjK8CAUD9h5oVCDVzsWKhn9u7e4rYZk4pq9xxIOhgkTTsdfsWJ+ZlY9KO7MIp5uBBT0gipcuhJMXQRqPWjWx5qzbW1vVC+7mK2+erX0m/mhMhM5RuwUDbAygXPTPHF9P+2TzrqLQ1bl42Tv37p+ZwgFbVt9lA8xhtJjMaLMyTJMUuShsNgAU0fDIjs01b2Wcb94mDuxpae3paWUGS27eF/EwuqCttp+Y2XxUZ+XdtUHLRIP+gXRy4VloBTsP6GN/3dnpu474NbcN8HLg4CF7jvA0m477/wfX8Lnoa+SgRCeSAn9i4noIkAFwjlQSgPeOxYZC9CeU4aF6cWyrPCoQYHE+B/gA6mjW7NFQ/q2ivKh2ty0a7y5WbP3aXUrtZcmAuT3MPSgFPs195Fy0n0zyM3y+MZucNnFgfD0ejrzXTqloYwGUq8khrVwDmTp0ToCSleV7vCZicFfEURETOl/clLBK/aJYoW3ExncGtvs15AmvGwvqlZR0160nTOCqY3+dqws7eU/lWb/r+xLly5ifeWk12sMqWZdmnN4EKtZcj4kEqHf7g2Jglow6cv9mGJAC76a8PtLtj19rGT0btOoF4VwrR6mpd+cCsTrER6SS53avNAUq2qsrRUPqbWal5Zo837XSrSs+b544t4zFvMH13IsXYdqk8UOO9TrTNql2ogrYZ3teZRLYH+Nx9naov7+CIOCm1rx6d0B8AgoX/1sEjoR0I/EvrhBYSOBd0buIAXEF5A8Nj+eQxeQODiNXgBdyK0EeAP5j1E5oVCDVwgwB9IQoB/97UhoR8J/ZAkry7eCgn9O3VOIKEfUqGXVEBCP+774Bbc94EL3PeBpL0jCfd9JPQjlAdyApoIcLFnTQShPAjlAY8hlAe4eKWhPEjoB/yPx8F07An9jeby2ovy9SwtbTZIlhj0wOlx/xlqFD9wKWLbJvv1eZ5jFdADhSKxc9jpgzRL/7+ZfeHWN1lhtQBfSm8cuGMulfboeyJUKmmjszZk2xopYJp5fqrFeLyV07//GLXY+ZjhpIwZb/McUGQ3IrsR2Y3IboRJFPrn8VzLYRI9aVzAJAqTKHjsQGUvTKInjYtTM4nuRGgj2hHMe4jMC4UauEC0I5CEaMfua0N2I7IbIUlenfMZ2Y07dU4guxFSoZdUQHYj7vvgFtz3gQvc94GkvSMJ931kNyKUB3ICmghwsWdNBKE8COUBjyGUB7h4paE8yG4E/I/HwXTS2Y0bZAs2fu6v+MTfyaQV2oSn0hvM06KK5uTzKENNZERDx7YZIf3OYyfzlax4keXe41AwS1keJcxvIkJrXy8Uj5nI7D1CmiT9Rmj6XGQ5rbLVwbRVwxQ8RjgUj+euADvNSeMCHiMg6Wg9RnVH8XxYeG3gtQGvQhsALuC1gdcGPHYoPAavDXABrw28NoD/i3ht+p7dqEy31B+V6VCZrlNluprCGUi72ynlkXaHU7fXqXusaXc90tXntZf3HLWxJcJBsYFiA8XmZRUbeHxgdTzSgx4eH+ACHh94fMBjxyN74fE5aVycmsdnJ0J7izdzuJ7AhweYMATTOEzjkAqHJxX6m8bb8/KKdLtdlmbtX/KmnTe2lBIFRjh8RmiRZcswKhilhIC2c25bX7OszLjDA1Rp5t8Pb5l/T3GAO/zpMwHu8MBF/zt8u4upd8pT6fxevNVXfloWj2vI9IWRjFNLaNrBzUVSEj55WtQRbb575odB4wQFoawVYel9fhOaytN55nW62VsW1lGh6kZnF/NnPr+ZSzpjAHewUFpBaSbN/0qa/UUBz34QiUFtGoaeMPzviyjvk4sJ69Ge/X2DY+u0xRPcfsDFjk3PRm7WLWGpYVMBmOVR6dErS9VmNLUJ+/YZOp/S8/Oi1HeBBB2ObHP6rDqps5NpeYU4b3HeQq4etlzFeQtc4Lw90vN2zB6E5GZPtlDKBgx50AzZZtTekoaxPvEWFvprjskSb5kmLCTZ/C2Ffsrgtgrd2ScltcqgOk28mCigwChHacAp9smLuIqY9idGl7I77Cn+J3mSmD+xLfOn0jiri9Z9FaltHLoRaRYwzToI4Vp5c2X2zu5i6Y0bhOGKLdwbQrdDRUl/pFxS4C0QYUlILNb7LCcFnP/94vKdHczCpf+Clq8YxZA9Vtg8eC0qrm2LazNHcXZ7ypcUq4nYhNfbQLCQZdGkNswbXth8FUnZ4ipHTesc72yZ1VtqOZHyOp3OLz8oR5Ev4sDhmqwciLuKqtK6+svEbBDF7qj/GPUJIJb9RJJ01QEkWeEoYi+giMVd05AKInRyLPzKQ/pim1c1JvvckqFClJWS5ZEHetKChfO/mUSlCfG7SQvifr44n027ghFnP7cn2+QK0u9iEnuBoLmmI2JdLmu8egAesTs6y7vdMkWrFKy5aDC/59vthTQuv2xDAVzb3JgYurdepHpb+yXaN3aA6eKUNeKupoucnBvekrDbe45uKysZrVpG3RGbH9HX8/41B0Z2+DaW4i76V4PYyneeii67cP9/ZQbvXu+9oOS1n5GaskL4pR0o1K9WMCvN6q1UxQQyjeMcxSVj+0Z3Cmuc33AEkWzzFpE7BjaKBZqNUVLMW8xmpc04X/i4gv2+gSKKPR57vghoI3LFcrYqVY+J+dRlfJTIZJaUkPQp1uyu4t2aryRh2tS9d4fuaBQ8X0xHo7OFPyqwunx3dnl5dnlZt9xiJk+MPS3ZeFyppFCroRq1U1HlmFqmUvEtinxUb40uUKtO+aDtt0h4h14XRjp6g8pCdInUa1Rf4copzvYflFPuOvsEz8I1eOslL2bvuW7dGB6oWQmL7AZysqlLEPPHxMLr0L/cPeb6s2le5rtOltpE8ojJJw8VoVYPi4pQqAi1G9GMilC4mBz5iYVQNeACFaFQEQo8diyyF9mkJ40LVITaTkWovsIan9gF80KhBi4OVajjE7uvGkl7+MTu1uLM69fWv0LVWvrNnBAv9XGGl/uqxZwgKHkJSbKl9CeUvDxuvzFKXkIq9JIKx/o1KNz3wS247wMXB4EL3PeBJNz3X/i+vwVPQ18lAqE8kBN7lxPQRIALhPIglAc8diyyF6E8J42LUwvlWeFQg4MJ8D9AB9P2Phq49oqWP/a05KJd5cstvgpVTe1qzYWxtZFmNfXqtqucRP88crM8npE7fGZxMByNvt5Mp25pCJOhxCupUQ2cM3lKhJ6Q4jXp+1l2UsD9+vvuvAazlwhetUsULbiZzuDW3ma9gDTjYX1Ts46a9KTpnBVMb/K1YWdvKf2rNv1/Y124chPvLSe7WGVKM+3SmsGFWsuQ8SGVDv9wbUwS0IZPX+zDEgFc7PIzSevtY++PKl0VwrR6mpd+cKtlqVaWSyt6dGrzQFKtqrK0VD6mvsRseY1Fpa8Nzh9fxGPeYv7oQo6161B9osB5n2qdUbupOOmKmkdNlceyKry2uGihbe34lO4AGCT0rx4WCf1I6EdCP7yA0LGgewMX8ALCCwge2z+PwQsIXLwGL+BOhDYC/MG8h8i8UKiBCwT4A0kI8O++NiT0I6EfkuTVxVshoX+nzgkk9EMq9JIKSOjHfR/cgvs+cIH7PpC0dyThvo+EfoTyQE5AEwEu9qyJIJQHoTzgMYTyABevNJQHCf2A//E4mI49ob/RXF57Ub6epaXNBskSgx44Pe4/Q43iBy5FbNtkvz7Pc6wCeqBQJHYOO32QZun/N7Mv3PomK6wW4EvpjQN3zKXSHn1PhEolbXTWhmxbIwVMM89PtRiPt3L69x+jFjsfM5yUMeNtngOK7EZkNyK7EdmNMIlC/zyeazlMoieNC5hEYRIFjx2o7IVJ9KRxcWom0Z0IbUQ7gnkPkXmhUAMXiHYEkhDt2H1tyG5EdiMkyatzPiO7cafOCWQ3Qir0kgrIbsR9H9yC+z5wgfs+kLR3JOG+j+xGhPJATkATAS72rIkglAehPOAxhPIAF680lAfZjYD/8TiYTjq7cYNswcbP/RWf+DuZtEKb8FR6g3laVNGcfB5lqImMaOjYNiOk33nsZL6SFS+y3HscCmYpy6OE+U1EaO3rheIxE5m9R0iTpN8ITZ+LLKdVtjqYtmqYgscIh+Lx3BVgpzlpXMBjBCQdrceo7iieDwuvDbw24FVoA8AFvDbw2oDHDoXH4LUBLuC1gdcG8H8Rr03fsxuV6Zb6ozIdKtN1qkxXUzgDaXc7pTzS7nDq9jp1jzXtrke6+rz28p6jNrZEOCg2UGyg2LysYgOPD6yOR3rQw+MDXMDjA48PeOx4ZC88PieNi1Pz+OxEaG/xZg7XE/jwABOGYBqHaRxS4fCkQn/TeHteXpFut8vSrP1L3rTzxpZSosAIh88ILbJsGUYFo5QQ0HbObetrlpUZd3iAKs38++Et8+8pDnCHP30mwB0euOh/h293MfVOeSqd34u3+spPy+JxDZm+MJJxaglNa670N6HJ6i8xPXqlpWwy1Jg9CMkNwbeQgAhuO2hua1NFtqRDrE+8hYX+mmOymNk2YSHJTT7avOPXzp4U5Tx8g+o08WKigAJ34LI04BT75EVcRUz7E3fgKrvDnuJ/kieJ+RPbMn8qjYmhaH3TE5jb8EhGpJn50nfdCAuNa+Xfldk7u4ulN24Q7Lv97va+qCjpj5RLCrwFIiwJicUqLeVQjvO/X1y+s4NZuPRfUGlQ80NlyB4rbB68FhXXtsW1maMoceMpX1KsJmI7H2jvFBvTVF1n3vDCRhlJyhZXOWpa53hni+PcUsuJlFdXcX75QTmKfBEHDtdk5UDcVVSV1tVfJmaDKHZH/ceoD9ux7CeSpKsOIMkKRxF7AUUs7ho8VhChk2b0Kw/pi21e1QDtc0uGClFWSpZHHuhJCxbO/2bCyybE7yYtiPv54nw27QpGnP3cHiKVK0i/i0nsBYLmmo6IdbkY1eoBeMTu6CzvdssUrVKw5qLB/J5vtxfSuPyyDWWLbHMtkjVaL1K9rf0S7Rs7wC5xyhpxV7tETs4Nb0nY7T37JMpKRquWUXfE5kf09bx/zYGRHb6NBdSK/lXXQ/nO00mXZf4s0nV+8bAb4Q4WCgoqzaT5X0mzvyjg2Q8iMdRLw9ATBoe+iPI+OVxtHPfs777XEAjFY2ETBLsCF7sNuDIWyw6mhOaL2fKoFbNoz4vLws2wXbHWlNU8LYnt4s7WuoVKs3pSFBPINI7zvStJ9I14zp4AG44gkm2aHvLTZyO3z2yMEmha/AalzThfqKNrS9kqotjjseeLgDYiVyxnq1L1mJhPXcZHiUxmSQlJn2LN7irW/vlKEqZNiVN36I5GwfPFdDQ6W/ijAqvLd2eXl2eXl3XLLWbyxNjTko3HlaS52mutuasqqgjnZSoVZYfzUb01ukDtOOHjpecioYK8Lox0VDnKQnSJ1Gsk2nLlFGf7D8opd51VW1+wnW09u3H2nuumCPNAzbIVM7PFyUapQswfEwuvQ/9y95jrz6Z5me86uXcSySMmnzwk/68eFsn/SP5H8j+S/3FiwR4KXCD5H8n/4LH98xgSB4ALJP/vLvm/r7DG19TAvFCogYtDFer4mtqrRtIevqZWTU5pRkcxsT2m+4b+1b9F/7IFa2lCc5K9VMXelyt1vPTZZ9RBgsxBHaQ60qEOEuogQSqc4icCYBkAt8AyAFwcBC5gGQCSYBk4WMvAFrwXfdUNhAdBouxdokBnAS4QHoTwIPDYschehAedNC5OLTwIX4MH/I/HFfWCX4Nt/1bAkjO37QO3i+lirfk1tkjbrLhn3XaVE/OfR26WGzRyh88sDoaj0deb6dQtDWGynngl3aqBcyZPidATUrymJECW8RRwv/6+Oy8e5CWCVy0YRQtupjO4tbdZLyDNeFjf1KyjJuVpOmcF05t8bdjZW0opqy0psLEuXLmJ95aT27XflNa0S7sHF2otk8eHVDr8w7UxXkBvPv0DAjYL4GKX9fjX28fe1fuvCmFaPfdLP3Q0mpfkcqc2DyTVqhpPS8Vr6qtil9dYVLva4KTyRTzmLYaSLuRYuwrWJwqc96nWGbWbynatqLjUVCwxKxxu6yEXetnBnOcdoIXCA6uHReEBFB5A4QF4FqGNQUsHLuBZhGcRPLZ/HoNnEbh4DZ7FnQhtpBeAeQ+ReaFQAxdILwCSkF5wVOkFKDyAwgOQOYca7YXCAzt1Y6DwAKRCL6mAwgOwDIBbYBkALmAZAJL2jiRYBlB4AOFBkCjQWYCLo9FZEB6E8CDwGMKDgItXGh6EwgOA//G4oo698ECjYb32onw9S4qbDZIlGz1wejym/DiKH7gUsW2T/fo8z/AK6IFCkdjR7ORBmhU0uJl9B9g3OWm1rLCUhjlwx1wq7dH3RKhU0kancsi2NVLANPP8VIvxeCt6Qv8xalH2MUNUGV3e5rmqyMJEFiayMJGFCTMrdNrD1mlhZgUuYGaFmRU8diyyF2bWk8bFqZlZdyK0EWsJ5j1E5oVCDVwg1hJIQqzlUcVaIgsTWZiQOYfq+kYW5k7dGMjChFToJRWQhQnLALgFlgHgApYBIGnvSIJlAFmYCA+CRIHOAlwcjc6C8CCEB4HHEB4EXLzS8CBkYQL+x+OKOukszA1yFRs/ilh8CPFkkhptElXpDeapVkVz8nmUoSYyoqFj24yQfuexk/lKVrzIcu9xKJilLI8S5jcRobWvF4rHTGT2HiFNkn4jNH1Us5zU2eqK2pMJC14oHJ/Hc6uAReekcQEvFJB0tF6oum+nz4eFfwf+HfAqtAHgAv4d+HfAY4fCY/DvABfw78C/A/i/iH+n79mNunhL/VEXD3XxOtXFqynbgVS+nVIeqXw4dXuduseaytcjBX5eTXrP8R1bIhwUGyg2UGxeVrGBxwdWxyM96OHxAS7g8YHHBzx2PLIXHp+TxsWpeXx2IrS3eDOH6wl8eICpRTCNwzQOqXB4UqG/abw9g69IzNtludf+xXHaeePFk6fAMofPMi1Sb3nvC5YqIaDtRHz5L3lW1rbDQ1lp5t8Pb5l/T3EAu8DpswvsAsBFf7tAu9uqdxpVSSdYtBRUfloWj2tI/4WRjKNMaFpzpb8JTVYniunRKy1lk6HG7EFIbgi+haRGcNtBc1ub0vLi2sb6ZF54pV9z9JZnNmAISW7yaeuDIVD2pChQ4htOSRMvJgoocAcuSwNOsU9exFXEtD9xB66yqPEU/5M8Scyf2Jb5U2lMIUXrm55g34bnNCLNzJfT60ZYaFwrU6/MLtv9Lr1xw2FxKN8x3xe9Jf2RckmBt0CuJRG1WKGmHJxy/veLy3d2MAus/gsqDWp+qAzZY4XNg9fi59q2uDZzFOV9POVLitVEbCI/2kCwEO3TVFlo3vDCxk1JyhZXOeha53hnCwPdUst5mFeWcX75QTmKfBEHDtdkJUa8ffFXeoP+EjkbRLE76j9GfciSZVSRJF11FUlW4IrYCyhicdfAuYIInTS4X3lIX2zzqqZqn1syVIiyUgY98kBPWlBz/jcTWjchfjdpwebPF+ezaVew7Ozn9vCwXJH7XUxiLxA018hErMslu1YPwCN2R2d5t1umaJUiOBci5vd8u72QxuWXbSjuZJtrkazRepHqbe2XaN/YAfaTU9bcu9pPcnJueJvDbu/ZH1NWR1r1kbobfn6YX8/71xwY2eHbWGau6F91u5TO8ppdXjBQdLXhSErCJxPQvmDc6GXbqF2s+c3MJO5rkD3N/rM3k4kIbKyyZQ1mpLZ7VjIxnT0X//hnMD1TmknTVJF8sIz39dkeK0N3onWihmdnisXBrfj+lt2qiEkdPr31ReROb0wfP5XcxKt/fbYAuEr4v8j886b887U/oSjjznKjgjLZg4HLYzNt5uteCLF2rxzT17n6+E/nX/Rk46nN3yzVEyH5n1bVe+u8efPvVGnnlhweO3pCToZYZ+ReJfyvpuOTSDMZ47GEe/f0NHLfvHFnupR7VR7PkMWu3R26/5cPMBqp0ej6P+wu/a5E/In+SEnp9yJ4+seMm55d5ufLnpE3A4N7bf5pQsCLTTC5GZqUdmJ6dHwWhuZB3t9UYozHwtIqR8TM8TBwzXZlk/z09vzt+TLFYudDQrGh0nVCPh/ngeSOnjDtZG1vSVkyXb3P99YS1RD3UUgbq/7I9cQSrbRk5SRS3EkWRUybGMnw6a2bKTpZyUqjtHOfYpVdajPKfpQikZw0k0+WeIlQOspqb+YtCrA715+vPn1efKPnmS7lDt03bz7ll0LnI8mIK0MK9ebN0PlWHsaQ+5sjZOXpVRDx+Js752NN3/VZEjJuCZ4L9Yx1vlasswN3WGYeAw+7vTcDdyKUNs2fn43i9kWG06l5/EdK0vJDLhetEPn67AZcmb+D/CRqeNG/zN7zR8ck5HzjwTebjjOhMoYeJ9y32+Q8sgxSdmVvV73kjPNiw3Z5lVLXHbj3hjHdyktOb6wubZnSLD1r8ku2wL9+NgMVQ5TyFc4Md7jTwazHle9Tohvb3pQE2McvZv9vRWAlRSQC00WyR3dg///QHbkjs2KRZMkRw+fs+bMbsvgutfcqNxvW/Pf/lCtlNg== -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment START

- - - - - -**Required Permissions**: `Experiment Start` or `Experiment Admin` - -## Request - -

Path Parameters

Body

required
- -The action to take on the experiment and a comment to go along with it. - -
- -A JSON Object with experiment data, the experiment note and an array of errors. - -
Schema
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • new_experiment_notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • experiment_note object
    reply_to objectnullable
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • experiment object
    application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • experiment object
  • ]
  • preview_variants object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment object
  • ]
  • alerts object[]
  • Array [
  • experiment object
  • ]
  • sample_size objectnullable
    experiment object
    variant_screnshots object[]
  • Array [
  • experiment object
    file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-stop.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-stop.api.mdx deleted file mode 100644 index ce43d491..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-stop.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: experiment-stop -title: "Experiment STOP" -description: "**Required Permissions**: `Experiment Stop` or `Experiment Admin`" -sidebar_label: "Experiment STOP" -hide_title: true -hide_table_of_contents: true -api: eJztXVtz4zaW/issvmTSq2k7dtdmRm9OarI7OzXprrh7X1peNkweSUiTBAOAdjsu/fctgJRIShRJUZJ18ZeqmTgibjz4zsHBufHZDUj5kieai9gdum/e/EZ/pFxS4HwgGXGluIjVmzdD58s/viUkeUSxdm61SL44QlZ+vAkiHn9xB27CJItIk1Tu8POzG7OI3KFLi5b/DNyBy81sCdNTd+DKfEp3qGVKg6UlfZyS84UHXxwxdvSUnGIg53HK/anzJFLnkcXa0cJRWiRv3YGr/ClFzB0+u/opMdPzWNOEpDtwx0JGTGc//ec7d+BGPOZRGrnDH2azu2w1pPRPIngy/VcXw3zzH2Y2zb6SY/6sLovFgcMcX0T2v7RwJsJhoYgnziPXU4frtzUv7YtYU6zNlCxJQu4zM8vF78rM+7z6QuL+d/K1IbcUCUnNSdm+frbSRTulJY8n5fc2NHIHLn1jURLS/IfZwI2FprqeRUuz8QmPJ5W3VU4sHMUnMR9z3+yDJJWGWjmPJMkZizQO3Jn9x7y1SkSssrVeXV6uUvjG+Z/b97867+3rZQQrTRYwzQbL9DbrzogeO0xK9mSgQlIKqQyld0TZbMBSOzuVgbKmSK3Szbxuscj28XlQC9cF8X8wO2R5qWmHNCntlaad2fVJtoSKYvwS+geu0qwNAjKNY/t6hk8fKBSJmcdjuhFzAdP0V80jcgdunIYhuzeDGeRns8ptRxBJ/wFKr2cezAbuOA1DT8T5kMutO0xRGuOBSc7ipoFqNuNy4EbsW/b39WzghkxpTxHFHo89XwS0FbliOV+VqsfEYuoyPkpkMktKSPoUazahGvCbU0BrkoajR6Pg+Wo2Gl0s/VGB1fW7i+vri+vruuUWM3li7GnJxmPutzDL5aWBBVHQSKV7PuEZk+Sjeht08SUxTUH3nSj1uX/qIMqlP+UPleXcCxESi8tvOmahMkRiD0wzWTfqCj2zpt6Yh+SlSShY4KUybGb7C1+K5JMML364vPz2w+XlxQ9vk0wKbEcGL1UkvTWyryKbAkqY1EuytGal/2byK+lcRFHEeO2bLdaVtTDCWnNtB/ikSPZdZJoEmxGjZnvmYwAjx4+RYq86LrKG1BX9p2nVH6dclfSe75RT7mpWE3PtZf17aRudNIz5e262cnJ4oIxeJlLpmCHUXnGxwor9zvD67W05xiHmT4qFN6F/uXvM9UfTvMx3696wosQnkkdMPnkRaVnRYzZk1YlgYeuEP152YuqPPCJzU/1JiK8bczaLRBprez83w9zTWEhymHMvxFdzWZwy5dwTxU7EAkuvJRFVM6x9NzOap4XH/CmnB5rfZ2g8NmSq6x8bFH12E6G45g/2dKUJy/9M46+xeIzduw03fY4iT2nZvOrnmZVqymchdcEB+VxVKRyn0X21pdm/Bxam5CmRSp+8HBxPzUtxZwsYPRkRoKll7Xvm8cqbH1I0G2Tt83hMUulPmaKNuOjGMctyxkI6WjI/4xrx6EQsfnLmIyqHSbI8ZGxO5kl+nJasGjs4VXFiHfuJ1U8DwmXkrHHRuHeNi14l90b7qNmki1V0DWbWKzELWe36XPppyORf/kuw8Hs313w0mzR2NA36C/pq5zo5r578qQjFhPssHH6UqYJR6Nx57GC3T+DiqHGxQ9lrJFeDOK3KQvO/j2zyfWVF+Y8rv1V+Jxa9tNA2c67tZB72F9b0zbgaFmtqvwS0q/EVYEConzHzQqEGLvYs1DN7d29x24xJRbV7DiQdDZJmnQ6/4sT8SCz63l0axfy4FFPSCKly6EkxdBGv9b1bHmrDtbW9UL7uYrbF6jfSbxaEyEzlW7BQNsDaBc9N8cX0/7a/dNRbGrYuGyd//dLvC4JU1Lb5j+Ix3kpiNF6cIUlOWZI0HAZLaHpvQGR/bWWfVdwvD+ZubenpbWkJRWbbHv43saCqsJ2X33hVbOTXtW3FQYv0g35x4lJhBTgF629509/vuYn7PrgF933g4ihwgfs+kIT7/gvf93fgaeirRCCUB3Li4HICmghwgVAehPKAx05F9iKU56xxcW6hPGscanAwAf5H6GDa6tZc8aBuvKJ8uCYX7Tpfbva7u5La1ZoLc2WSe1gacIr92rtoOYn+eeRmeTwjd/jM4mA4Gn2+m83c0hAmQ4lXUqMaOGf6lAg9JcXralfY7KSArykmYqa0j7xE8KpdomjBzXQGt/Y26wWkGQ/rm5p11KQnzRasYHqTrw07eyvpX7Xp/1vrwpWbeG852cUqU5ppn9YMLtRGhoz3qXT4+1tjkoA2fP5iH5YI4KK/Ntzugt1sHzsZvesE6k0hTKuneemBW5lgLdJLcrlTmweSal2VpZXyMbVW88oabd7vSpGeDc8fX8Rj3mL+6EKOjetQ/UaB81OqdUbtUg2k9fCu1jyqJdD/5uPMbHEfX8RBoW3t+ZTuABgk9K8fFgn9SOhHQj+8gNCxoHsDF/ACwgsIHjs8j8ELCFy8Bi/gXoQ2AvzBvMfIvFCogQsE+ANJCPDvvjYk9COhH5Lk1cVbIaF/r84JJPRDKvSSCkjox30f3IL7PnCB+z6QdHAk4b6PhH6E8kBOQBMBLg6siSCUB6E84DGE8gAXrzSUBwn9gP/pOJhOPaG/0Vxee1G+naelzQfJEoMeOD0ePkON4gcuRWzbZE+fFzlWAT1QKBI7h50+SLP0/7v5F259kxVWC/CV9MaBO+ZSaY++JUKlkrY6a0O2q5ECppnnp1qMxzs5/fuPUYudDxlOypjxts8BRXYjshuR3YjsRphEoX+ezrUcJtGzxgVMojCJgseOVPbCJHrWuDg3k+hehDaiHcG8x8i8UKiBC0Q7AkmIduy+NmQ3IrsRkuTVOZ+R3bhX5wSyGyEVekkFZDfivg9uwX0fuMB9H0g6OJJw30d2I0J5ICegiQAXB9ZEEMqDUB7wGEJ5gItXGsqD7EbA/3QcTGed3bhFtmDj5/6KT/ydTVqhTXgqvcEiLapoTj6PMtRERjR0bJsR0u88drJYyZoXWe09DgWzlOVRwvwmIrT29ULxmInM3iOkSdJvhKbPRZbTKlsdTDs1TMFjhEPxdO4KsNOcNS7gMQKSTtZjVHcUL4aF1wZeG/AqtAHgAl4beG3AY8fCY/DaABfw2sBrA/i/iNem79mNynQr/VGZDpXpOlWmqymcgbS7vVIeaXc4dXuduqeadtcjXX1Re/nAURs7IhwUGyg2UGxeVrGBxwdWxxM96OHxAS7g8YHHBzx2OrIXHp+zxsW5eXz2IrR3eDOH6wl8eIQJQzCNwzQOqXB8UqG/abw9L69It9tnadb+JW/aeWNHKVFghONnhBZZtgqjglFKCGg753b1NcvKjHs8QJVm/tfhPfO/UhzgDn/+TIA7PHDR/w7f7mLqnfJUOr+Xb/WVR6vicQOZvjSScWoJTXu4uUhKwidPizqiLXbPPBg0TlAQyloRVt7nV6GpPJ1nXqebvWVpHRWqbnV2MX/u85u7pDMGcAdLpRWUZtL8W9L8Lwp49kAkBrVpGHrC8L8vorxPLiasR3v+9x2OrfMWT3D7ARd7Nj0buVm3hJWGTQVgVkelR68sVZvR1Cbs22fofEovzotS3yUSdDiyzemz7qTOTqbVFeK8xXkLuXrcchXnLXCB8/ZEz9sxexCSmz3ZQSkbMORRM2SbUXtHGsbmxFta6C85Jku8ZZqwkGTztxT6KYO7KnRnfympVQbVaeLFRAEFRjlKA06xT17EVcS0PzW6lN1hT/E/yZPE/Kltmf8qjbO6aN1XkdrFoRuRZgHTrIMQrpU3N2bv7C6W3rhBGK7ZwoMhdDdUlPRHyiUF3hIRVoTEcr3PclLA5d+vrt/ZwSxc+i9o9YpRDNljhc2D16Li1ra4NXMUZ7enfEmxmopteL0NBEtZFk1qw6Lhlc1XkZQtrnLUtM7xzpZZvaeWEymv0+n8/J1yFPkiDhyuycqBuKuoKq2rv0zMBlFsQv3HqE8AsewnkqSrDiDJCkcRewFFLO6ahlQQoZNj4Rce0ifbvKox2d8tGSpEWStZHnmgpy1YuPybSVSaEp9MWxD349XlfNo1jDh/3J5skytIv4tp7AWCFpqOiHW5rPH6AXjEJnSRd7tnitYpWAvRYJ7n2+2FNC6/bEMBXNvcmBi6t16melv7Fdo3doDp4pw14q6mi5ycW96SsNsHjm4rKxmtWkbdEZsf0beL/jUHRnb4NpbiLvpXg9jKd56KLrt0/39lBu9e772k5LWfkZqyQvilHSjUr1YwK83qrVTFBDKN4xzFJWP7VncKa5zfcgSR7PIWkTsGtooFmo9RUsxbzGalzbhc+riC/b6BIoo9Hnu+CGgrcsVyvipVj4nF1GV8lMhklpSQ9CnWbFLxbi1WkjBt6t67Q3c0Cp6vZqPRxdIfFVhdv7u4vr64vq5bbjGTJ8aelmw8rlRSqNVQjdqpqHJMrVKp+BZFPqq3QReoVed80PZbJLxDrwsjHb1BZSG6QuoNqq9w5RRn+3fKKXedf4Jn6Rq885IX8/fctG4MD9S8hEV2Aznb1CWI+VNi4U3oX+4ec/3RNC/zXSdLbSJ5xOSTh4pQ64dFRShUhNqPaEZFKFxMTvzEQqgacIGKUKgIBR47FdmLbNKzxgUqQu2mIlRfYY1P7IJ5oVADF8cq1PGJ3VeNpAN8Yndnceb1a+tfoWoj/WZBiJf6OMPLfdViQRCUvIQk2VH6E0penrbfGCUvIRV6SYVT/RoU7vvgFtz3gYujwAXu+0AS7vsvfN/fgaehrxKBUB7IiYPLCWgiwAVCeRDKAx47FdmLUJ6zxsW5hfKscajBwQT4H6GDaXcfDdx4Rasfe1px0a7z5RZfhaqmdrXmwtjaSPOaenXbVU6ifx65WR7PyB0+szgYjkaf72YztzSEyVDildSoBs6ZPiVCT0nxmvT9LDsp4H79fXdRg9lLBK/aJYoW3ExncGtvs15AmvGwvqlZR0160mzBCqY3+dqws7eS/lWb/r+1Lly5ifeWk12sMqWZ9mnN4EJtZMh4n0qHv781Jglow+cv9mGJAC72+Zmkzfax90eVbgphWj3NSw/calmqteXSih6d2jyQVOuqLK2Uj6kvMVteY1Hpa4vzxxfxmLeYP7qQY+M6VL9R4PyUap1Ru6k46ZqaR02Vx7IqvLa4aKFt7fmU7gAYJPSvHxYJ/UjoR0I/vIDQsaB7AxfwAsILCB47PI/BCwhcvAYv4F6ENgL8wbzHyLxQqIELBPgDSQjw7742JPQjoR+S5NXFWyGhf6/OCST0Qyr0kgpI6Md9H9yC+z5wgfs+kHRwJOG+j4R+hPJATkATAS4OrIkglAehPOAxhPIAF680lAcJ/YD/6TiYTj2hv9FcXntRvp2npc0HyRKDHjg9Hj5DjeIHLkVs22RPnxc5VgE9UCgSO4edPkiz9P+7+RdufZMVVgvwlfTGgTvmUmmPviVCpZK2OmtDtquRAqaZ56dajMc7Of37j1GLnQ8ZTsqY8bbPAUV2I7Ibkd2I7EaYRKF/ns61HCbRs8YFTKIwiYLHjlT2wiR61rg4N5PoXoQ2oh3BvMfIvFCogQtEOwJJiHbsvjZkNyK7EZLk1Tmfkd24V+cEshshFXpJBWQ34r4PbsF9H7jAfR9IOjiScN9HdiNCeSAnoIkAFwfWRBDKg1Ae8BhCeYCLVxrKg+xGwP90HExnnd24RbZg4+f+ik/8nU1aoU14Kr3BIi2qaE4+jzLUREY0dGybEdLvPHayWMmaF1ntPQ4Fs5TlUcL8JiK09vVC8ZiJzN4jpEnSb4Smz0WW0ypbHUw7NUzBY4RD8XTuCrDTnDUu4DECkk7WY1R3FC+GhdcGXhvwKrQB4AJeG3htwGPHwmPw2gAX8NrAawP4v4jXpu/Zjcp0K/1RmQ6V6TpVpqspnIG0u71SHml3OHV7nbqnmnbXI119UXv5wFEbOyIcFBsoNlBsXlaxgccHVscTPejh8QEu4PGBxwc8djqyFx6fs8bFuXl89iK0d3gzh+sJfHiECUMwjcM0DqlwfFKhv2m8PS+vSLfbZ2nW/iVv2nljRylRYITjZ4QWWbYKo4JRSghoO+d29TXLyox7PECVZv7X4T3zv1Ic4A5//kyAOzxw0f8O3+5i6p3yVDq/l2/1lUer4nEDmb40knFqCU0brvRXocnqLzE9eqWlbDPUmD0IyQ3Bd5CACG47am5rU0V2pENsTrylhf6SY7KY2TZhIcltPtq859fOfinKefgG1WnixUQBBe7AZWnAKfbJi7iKmPan7sBVdoc9xf8kTxLzp7Zl/qs0Joai9V1PYO7CIxmRZuZL33UjLDWulX83Zu/sLpbeuEGw7/e724eioqQ/Ui4p8JaIsCIklqu0lEM5Lv9+df3ODmbh0n9BpUHNg8qQPVbYPHgtKm5ti1szR1HixlO+pFhNxW4+0N4pNqapus6i4ZWNMpKULa5y1LTO8c4Wx7mnlhMpr67i/PydchT5Ig4crsnKgbirqCqtq79MzAZRbEL9x6gP27HsJ5Kkqw4gyQpHEXsBRSzuGjxWEKGTZvQLD+mTbV7VAO3vlgwVoqyVLI880NMWLFz+zYSXTYlPpi2I+/Hqcj7tGkacP24PkcoVpN/FNPYCQQtNR8S6XIxq/QA8YhO6yLvdM0XrFKyFaDDP8+32QhqXX7ahbJFtrkWyQetlqre1X6F9YwfYJc5ZI+5ql8jJueUtCbt9YJ9EWclo1TLqjtj8iL5d9K85MLLDt7GAWtG/6noo33k66bLMn0e6Li4ediPcwVJBQaWZNP+WNP+LAp49EImhXhqGnjA49EWU98nhauO453/3vYZAKJ4KmyDYFbjYb8CVsVh2MCU0X8xWR62YRXteXJZuhu2Ktaas5mlJbBd3ttYtVJrVk6KYQKZxnO9dSaJvxXP2BNhyBJHs0vSQnz5buX3mY5RA0+I3KG3G5VIdXVvKVhHFHo89XwS0FbliOV+VqsfEYuoyPkpkMktKSPoUazapWPsXK0mYNiVO3aE7GgXPV7PR6GLpjwqsrt9dXF9fXF/XLbeYyRNjT0s2HleS5mqvteauqqginFepVJQdzkf1NugCteOMj5eei4QK8row0lHlKAvRFVJvkGjLlVOc7d8pp9x1Xm19yXa28+zG+XtumiLMAzXPVszMFmcbpQoxf0osvAn9y91jrj+a5mW+6+TeSSSPmHzykPy/flgk/yP5H8n/SP7HiQV7KHCB5H8k/4PHDs9jSBwALpD8v7/k/77CGl9TA/NCoQYujlWo42tqrxpJB/iaWjU5pRkdxcT2mO4b+lf/Fv3LFmykCS1I9lIVe1+u1PHKZ59RBwkyB3WQ6kiHOkiogwSpcI6fCIBlANwCywBwcRS4gGUASIJl4GgtAzvwXvRVNxAeBIlycIkCnQW4QHgQwoPAY6ciexEedNa4OLfwIHwNHvA/HVfUC34Ntv1bASvO3LYP3C6ni7Xm19gibfPinnXbVU7Mfx65WW7QyB0+szgYjkaf72YztzSEyXrilXSrBs6ZPiVCT0nxmpIAWcZTwP36++6ieJCXCF61YBQtuJnO4NbeZr2ANONhfVOzjpqUp9mCFUxv8rVhZ28lpay2pMDWunDlJt5bTu7WflNa0z7tHlyojUwe71Pp8Pe3xngBvfn8DwjYLICLfdbj32wfe1fvvymEafXcLz3oaDQvyeVObR5IqnU1nlaK19RXxS6vsah2tcVJ5Yt4zFsMJV3IsXEVrN8ocH5Ktc6o3VS2a03FpaZiiVnhcFsPudDLjuY87wAtFB5YPywKD6DwAAoPwLMIbQxaOnABzyI8i+Cxw/MYPIvAxWvwLO5FaCO9AMx7jMwLhRq4QHoBkIT0gpNKL0DhARQegMw51mgvFB7YqxsDhQcgFXpJBRQegGUA3ALLAHABywCQdHAkwTKAwgMID4JEgc4CXJyMzoLwIIQHgccQHgRcvNLwIBQeAPxPxxV16oUHGg3rtRfl23lS3HyQLNnogdPjKeXHUfzApYhtm+zp8yLDK6AHCkViR7OTB2lW0OBu/h1g3+Sk1bLCShrmwB1zqbRH3xKhUklbncoh29VIAdPM81MtxuOd6An9x6hF2YcMUWV0edvnqiILE1mYyMJEFibMrNBpj1unhZkVuICZFWZW8NipyF6YWc8aF+dmZt2L0EasJZj3GJkXCjVwgVhLIAmxlicVa4ksTGRhQuYcq+sbWZh7dWMgCxNSoZdUQBYmLAPgFlgGgAtYBoCkgyMJlgFkYSI8CBIFOgtwcTI6C8KDEB4EHkN4EHDxSsODkIUJ+J+OK+qsszC3yFVs/Chi8SHEs0lqtElUpTdYpFoVzcnnUYaayIiGjm0zQvqdx04WK1nzIqu9x6FglrI8SpjfRITWvl4oHjOR2XuENEn6jdD0Uc1yUmerK+pAJix4oXB8ns6tAhads8YFvFBA0sl6oeq+nb4YFv4d+HfAq9AGgAv4d+DfAY8dC4/BvwNcwL8D/w7g/yL+nb5nN+rirfRHXTzUxetUF6+mbAdS+fZKeaTy4dTtdeqeaipfjxT4RTXpA8d37IhwUGyg2ECxeVnFBh4fWB1P9KCHxwe4gMcHHh/w2OnIXnh8zhoX5+bx2YvQ3uHNHK4n8OERphbBNA7TOKTC8UmF/qbx9gy+IjFvn+Ve+xfHaeeNF0+eAsscP8u0SL3VvS9YqoSAthPx5b/kWVnbHg9lpZn/dXjP/K8UB7ALnD+7wC4AXPS3C7S7rXqnUZV0gmVLQeXRqnjcQPovjWQcZULThiv9VWiyOlFMj15pKdsMNWYPQnJD8B0kNYLbjprb2pSWF9c2Nifz0iv9kqO3PLMBQ0hym09bHw2Bsl+KAiW+4ZQ08WKigAJ34LI04BT75EVcRUz7U3fgKosaT/E/yZPE/Kltmf8qjSmkaH3XE+y78JxGpJn5cnrdCEuNa2Xqjdllu9+lN244LI7lO+aHorekP1IuKfCWyLUiopYr1JSDUy7/fnX9zg5mgdV/QaVBzYPKkD1W2Dx4LX5ubYtbM0dR3sdTvqRYTcU28qMNBEvRPk2VhRYNr2zclKRscZWDrnWOd7Yw0D21nId5ZRnn5++Uo8gXceBwTVZixLsXf6U36C+Rs0EUm1D/MepDliyjiiTpqqtIsgJXxF5AEYu7Bs4VROikwf3CQ/pkm1c1Vfu7JUOFKGtl0CMP9LQFNZd/M6F1U+KTaQs2f7y6nE+7hmXnj9vDw3JF7ncxjb1A0EIjE7Eul+xaPwCP2IQu8m73TNE6RXAhRMzzfLu9kMbll20o7mSba5Fs0HqZ6m3tV2jf2AH2k3PW3LvaT3Jybnmbw24f2B9TVkda9ZG6G35+mN8u+tccGNnh21hmruhfdbuUzvKaXV4yUHS14UhKwicT0L5k3Ohl26hdrHlmZhJfa5A9y/6xN5OpCGyssmUNZqS2e1EyMV08F//xz2B2ocxBMHAVyQfLd5+f7akydKdaJ2p4caFYHNyLb2/ZvYqY1OHTW19E7uzO9PFTyU24+udnu/83Cf8Xmf+8Kz++9acUZcxZblQQJvth4PLYTJu5upcirN0bx/R1bj780/kXPdlwavM3S/VUSP6n1fTeOm/e/DtV2rknh8eOnpKTAdYZuTcJ/6vp+CTSTMR4LOHeV3oauW/euHNVyr0pj2fIYtfuDt3/ywcYjdRodPsfdpN+VyL+jf5ISemfRPD0jzkzPbvMz5edUzeDgnurRZKYAPBiCxymnFg4ik9iPua+UWIlqTTUynkkaV4gzbwMPB4LS7QcGXMHxMA1+5bN9sPby7eXq6SLnfcJxYZctwn5dhrzyNFTpp2s7T0pS6+bn/JNttQ1VH4U0sasP3I9tdQrLV45iRQTyaKIaRMrGT69dTOFJytdaZR37lOsssttRuIPUiSSk2byyVIxEUpHWQ3OvEUBeuf24/sPyy/0PFep3KH75s1v+d3Q+UAy4spQQr15M3S+lEfRIvniCFn58SaIePzFXXCzpm/6IgkZtzeGXLRnDPS5YqMduMMyCxmUmF2+G7hTobRp/fxstLdPMpzNzM9/pCQtV+TC0UqSz89uwJX5O8iPo4bX/Mv8Lb93TFbOFx58sTk5UypD6XHKfbtHzqPBkRaOWdjbda84Z7/Y8F5eqdR1B+5Xw51u5RVnd1aftpxpVp41+Tlb318/moGKIUo5CxeGRdzZYN7jxvcp0Y1t70pC7MOnj+7AvReBFReRCEwXyR7dgf3/oTtyR2bFIskSJIbP2e/PbsjiSWrvVm42rPnn/wFpnGnE -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment STOP

- - - - - -**Required Permissions**: `Experiment Stop` or `Experiment Admin` - -## Request - -

Path Parameters

Body

required
- -The action to take on the experiment and a comment to go along with it. - -
- -A JSON Object with experiment data, the experiment note and an array of errors. - -
Schema
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • new_experiment_notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • experiment_note object
    reply_to objectnullable
    experiment object
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • experiment object
    application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • experiment object
  • ]
  • preview_variants object[]
  • Array [
  • experiment object
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment object
  • ]
  • alerts object[]
  • Array [
  • experiment object
  • ]
  • sample_size objectnullable
    experiment object
    variant_screnshots object[]
  • Array [
  • experiment object
    file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-tag-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-tag-get.api.mdx deleted file mode 100644 index 0db692b4..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-tag-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: experiment-tag-get -title: "Experiment Tag GET" -description: "**Required Permissions**: `Experiment Get` or `Experiment Admin`" -sidebar_label: "Experiment Tag GET" -hide_title: true -hide_table_of_contents: true -api: eJztXd1z2zYS/1cweGnjUy0l6Uzv9ObetLlep02mdu7F8jEQuRIRkwALgLZVjf73DkBKIiWKpL5iS9mHTlQSWCyWv/0AFgtPaQDaVzwxXArapxcXf8CfKVcQkA+gYq41l0JfXPTJp5+eElA8BmHIOzCfiFSlZ1dBzMUn2qEJUywGA0rT/u2UChYD7VNYtLxh418C2qHcjpcwE9IOVfmgtG9UCh2q/RBiRvtTaiaJ7c6FgTEoOuusMHwTAuEBkSNiQiAFfm7YmJiQGTKRKXnkOiRGkjEYEjDDyEjJ+JLO7uzQOpFCg7ajven17D/lIa7If6/f/07eDz+Db4gvhWFccDEmTJDltIhh42+0o35JO9Q2A2EsNZYkEfeZpdb9rC3J6foEpaNuxadkAsrwjKElfc+wcXN7HlQLrdxZG8XFmHYoPLE4ibJHzL/vD5l/DyKwPXwFzEDgMVPVcSRVbN/QgBn4zvAYin2Gk2ZOmfJD/gBFfodSRsBEka8RizTMOpQ9MMNUFVWRRhEb2rYWOoum3ohH4KVJJFngpSqqn33XVzL5qKLu617v6XWv1319mYjx/mLwUg3Kq/woHRpzweM0pv3XDtUJUybOIbOZ09+YugfDM+YgZrxyZgu+shYziwBuHIGPOkNEKyZnHZomQUEAZWl3WgpkTgNx8cJxUSG25bcrMr0BBwXcLC2XLnDClGITa/wNxCsGbkfjVhCClVfmbuokZUAbrzDszHGjWGbtm76HNsw0DKBSIfIPEcADRDJx9rs1Uio+gjZM7UtBJrsTKEzPvph16CiNIk+KvczCnMYDU5yJOkIVH6PXoTF7yn6/nXVoxLTxNIDwuPB8GcBe4hJqzpWuxsRi6CI+CmKyLCWgfBCGjUFXcZIwY0DZCGMwCKZvZoNBd+VHCVZvv+++fdt9+7aK3eVInhx5RrHRiPsNytLrWVhAydKuS2nIxzxTkpyqt0UXjCHO2FfsyGQ5nthNOzGeOB2MVMcPNUxWiLq0Hqvj+ibkurAms+uxQlfLjeDGy/rvupRqjjDm89yOc7uO1XYhK1NFLAl9VFwcPLTfLjxEM386KryN/IvdBTc3tnlR7zbNsBTEJ4rHTE28GIwqxTFbqupYsqhxwB96rZT6hsdgt5B+lPJ+a81msUyFcbtUlswQRlIBYWQo5b3dSQqZJkMAQWIWOHmtmKgKsm5ulppnpMf8kMMDzNczMBpZMVX1FxZFtzSRmhv+4LwrjFn+MxX3Qj4KerflR5+jyNNG1XM9nTmrpn0WQRscgM91WcIijYfllvb7PbAoBU/LVPng5eCY1LNCZwsYTawJMNDA+5F1vDTz5zTNFlnHdI9JqvyQadhKi66IZYuMpCJGMT/TGvlIYiYmZE5RE6bA6RCRgtg3uTstbMEewKuix3rpHmu3CAgXI2eNi9abm2tMr4t7q+9o2Lh2D7QeM5uDmIWtpj5Xfhox9e07yaJXNI98DBvXdjxySinREz+UkRxzn0X9G5Vq3BQ6dx3DxBLi4si211quGnNatoX2vxs2flXiKH+49qz0HFj8pY22HXNjJ/tyd2MNTzbVsOCpeRHQHMaXgIFG/YyVFwNqxMWRjXq2372zua3HpIbKb45IejFImrVyfkuPeQMsfkVXqNiHjvQOR0+WpJdHCF/RIqkteWuaUM73crQF91vFNwtBZFvle6hQRmAjw/Ot+OXwv7knLeOWmk+X0cmnX3i+EEgpbJs/lI9iL4tRu3BGS3LKlqTGGayg6b0FkXvaqD7ruF8lRvfe6dl5pyWS2d52/z/AgnLAdl5543WzkS/X9jUHDdYP44sTtwprwFmq/p4r/eP6TVzvo7bgeh9x8SJwget9RBKu97/wev8AmYZdgwg8yoN24tntBEYiiAs8yoNHeVDHTsX24lGes8bFuR3l2ZBQwwQTwv8FJpj2WjWXMqhbc5STq0vRbsrlZs/pWmlXYy3MG1vcw9KAg/Ar16LFIvrpgGZ1PAPanzIR9AeD27vZjBZI2AolXiqNqtGccJJIE4LmFeX7WXVSwP3q9a4d0r3yEsnL+xLLFtwOZ3HrVrNeAIbxqLqp5aOiPGm2UAXbG3xj1dlbK/+qLP/fOxYurcR3tpNtdmUKIx1zN4NLvdVGxvtUEf7+2m5JYDR8/mYfdyIQF8e8MWm779hq07vKoF4tjWnZmxde0NIAG5FesMut2jyA0ptuWVq7PqZy17zEo6v7XbukZ0v/40sx4g3bH23EsfU9VH9AQH5MjcmkXbgDaTO8y3ceVQrofzmdmbvcx5ciWEZbR/bSLQCDBf2byWJBPxb0Y0E/ZgExxsLYG3GBWUDMAqKOPb+OYRYQcfE1ZAGPYrTxgD8q70tUXgyoERd4wB+RhAf82/OGBf1Y0I+W5Ks7b4UF/UdNTmBBP1qFnawCFvTjeh+1Bdf7iAtc7yOSnh1JuN7Hgn48yoN2AiMRxMUzRyJ4lAeP8qCO4VEexMVXepQHC/oR/qeTYDr1gv7a7fLKhfL1vCxtTiQrDHrg8Pj8FWogHriSwrXJ3k4XNVYBPEAkEzeGGz5Is/L/u/lfuPVtVVglwNfKGzt0xJU2HjwlUqcK9vK1ETsUpYAZ5vmpkaPRQbz/7jQqsfMhw0kRM97+NaBY3YjVjVjdiNWNuCWK8efpLMtxS/SscYFborglijr2Qm0vbomeNS7ObUv0KEYbTzui8r5E5cWAGnGBpx0RSXjasT1vWN2I1Y1oSb665DNWNx41OYHVjWgVdrIKWN2I633UFlzvIy5wvY9IenYk4XofqxvxKA/aCYxEEBfPHIngUR48yoM6hkd5EBdf6VEerG5E+J9Ogumsqxv3qBas/XN/yz/xdzZlha7gqTCDRVnUsjn4PM5QE1vT0LJtJki/Ne1kwcmGiaz3HkWSOcnyOGF+nRAa+3qRfMxM5s4U0iTZjULdn4ssllU2JpgOujGFGSN0iqezVsB9mrPGBWaMEEknmzGqcsULspi1wawN6ipGA4gLzNpg1gZ17KXoGGZtEBeYtcGsDcL/i2RtdvXdeDPdWn+8mQ5vpmt1M13FxRlYdndUyWPZHXrdnbzuqZbd7VCuvrh7+ZlPbRxIcBjYYGCDgc2XDWww44O7jifq6DHjg7jAjA9mfFDHTsf2YsbnrHFxbhmfoxjtA67MMfWEevgCC4Zwaxy3xtEqvDyrsPvWeHNd3rLc7phXs+5+5U2zbhyoJAoV4eUrQoMtW4fRUlEKCKj3c1UQKuDSRasdKqSBIzhLBUk08YyscicLadoXndoBlnNwgeuaWH6XBorDeXY67UL8FT5Kkt1L/5g/32aeZ0EyQNLOSjWvNkzZfxXMf0HAsxcysShKo8iTVh99Ged9crV1SZT57zvc7Th7c4E7zYiLY+52WLtZxcJaw7o7B9apwqNXtKr1aGoy9s0jtM49LvxFoe+KCFp4U+t9ykHoqmda5xD9LfpbtKsv266iv0VcoL89UX87Yg9ScftNDnB7Airki1bIpn2UA0UY2wtvhdGfc0wWdMs2YRGo+uu7dwsGD3W3kntSCKssqtPEEwABBDY4SgMOwgcv5jpmxg9tLOW+sKf5X+ApYH7oWuZPlc2PLFvvGkgdwunGYFjADGthhCvtzZX9du4rFmZcYww3fMJnQ+hhpKjgz5QrCLwVIawZidUr5ornUHv/evP2e0fMwWV3htaXGEuSO3BYT7wSFdeuxbUdY+m7Pe0rEDqU++h6EwhWDvbWhQ2Lhm/cEWkFGXMlV9M4xvfuZr8hNHik/Go48u9vNNHgSxEQbsDZAdHWVBX42t0mZkQ0G8PuNKrPHDv1k0nSNgZQ4IyjFF4AMRNtT74vhdBqz/9nHsFH17wcMbnnTgwloWy0LI88MGEDFnr/tGfjQ+DjsAFxP7zpzYfdoIjz183nu/MA6bMMhRdIWEQ6UpjiTZqbCfCYjaGbdxsyDZsCrIVpsO/zz+1FMCpOtubORdfcbjG0b70q9ab2a7Kv7YBbF+ccEbfdusjFuecqCb/2Mx+oKAYZjVFGlYvNXfT1on+Fw8icb+3tr8v+5XMTxTVPq1i2nODecCWdzV6vNt0inV6itInf/NVslh9NC2VgC+LAKQGz9pl2V7Lx3SkUu/8SzOziB9SD07HbqfMgfRoak+h+t6uZCIby6ZINdcyUiSaXvozp7M728VPFbW3Z7dR966uE/wr2f++Kr6/9EOJMEYuNlp8/e9ChXNhhs3NpK+VQ9IrYvuTqwy/kV5i42if7m6UmlIr/5WK1S3Jx8VuqDRkC4YKYEEgGTjKgVwn/znacyDQzJx5LuHcPkwG9uKDzsIleFelZsTjeaZ/+PycwGOjB4PofDmZcjFwuY/5Vhsy/B2GXklaUGd+vL3uXvfXZCPI+AWFncJ2Az0d5QRYxITMkazsE7aZw9WMudzdhO/FHqVzN1yM3oZsQKVybSBIlx4rFMTO21iCaXNIs3sgudLYRMfdB6GwdmM36g5KJ4mCYmriJJVKbOLuZOm+xBBy5YWPy7qeb1TlN50EN7dOLiz/yNRf5ACrm2gpDX1z0yacCoXdgPhGpSs+ugpiLT3SxIjXwZLpJxLgLxHPbmuH6du2USYf2V5BN7zo0lNrY1tOpDZ8+qmg2s4//TEE5qObWyZn12ykNuLa/g9wf1Mzy2/kkXxFb18oDV9MaAlkRlvumE5mSR65DWzY7BkPssp6MlIwvN012rh3CqkZ+lzelHXpvlYeuTnR256Jbpzt2GlmrK9+HxBT6F4r/up+1Xd7cFcyG/ayz2d8eYRNW -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Tag GET

- - - - - -**Required Permissions**: `Experiment Get` or `Experiment Admin` - -## Request - -

Path Parameters

- -A JSON Object containing an experiment tag's data. - -
Schema
    experiment_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiment-tags-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiment-tags-list.api.mdx deleted file mode 100644 index 8f866e90..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiment-tags-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: experiment-tags-list -title: "Experiment Tags LIST" -description: "**Required Permissions**: `Experiment List` or `Experiment Admin`" -sidebar_label: "Experiment Tags LIST" -hide_title: true -hide_table_of_contents: true -api: eJztXW1z2zYS/isYfLmLT7WVpDe90zf3pu31+pJM7dwXy8dA5EpCTAIMANpWNfrvNwApiZQokqKkWFK2M52qJLBcLJ59ARYLT2kA2lc8NlwK2qMXF3/A54QrCMh7UBHXmkuhLy565OMPzzEoHoEw5FeuzUciVeHhdRBx8ZF2aMwUi8CA0rR3N6WCRUB7VEtlaIdy+5XPCagJ7ax8+3YMRA4+gW/IA0yIkcT2IWYMRIFOQqPJYHJJO1T7Y4gY7U2pmcSOtlFcjGiHwjOL4tA+cl+dzTqF73tM+6s8rBEbSBkCE3lqRiWQpxWzEdTS4cLACFSezus8EW4g0m2o/H02u+9QBTqWQoO2jd90u/Y/RXlek//cvPudvEtF6kthGBdcjAgThCnFJkQOCQtDAstJNGykrYhtaxDGEmVxHHKfWaJXn7SlPF1nM503O/lKxqAMT/lKx7g+mlknlWHZOCMueJREVlodaqRhYTmBJdee5TrXyA3OSnbl65uYDMo/YNioGmPaMP+hN2D+A4jA9vAVMAOBx0xZx6FUkX1DA2bgG8MtQJd9BpN6Tpnyx/wRgmq0DlmoYdah7JEZpsqoiiQM2WCB7HlTb8hD8JI4lCzwEhVWj/7KVzL+oMKr193u8+tu9+r1ZSxGu4vBSzQor3RSVsARQMyUiTKcbub0N6YewPCUOYgYLx3Zgq+0xcwigBtH4INOEdGIyVmHJnGQE0BR2p2GApnTQFwcOS5KxLacuzzTG3BQatIqzdmyWUvjVnBJncwhVUnKgDZe7rMzx41iqaepmw9tmKn5gEqEyCYigEcIZewMe2OklEyCNkztSkHG7QnkhmdfzDp0mIShJ8VOZmFO45EpzkQVoZLJ6HZoxJ7T329nHRoybTwNIDwuPF8GsJO4hJpzVeby85/O4yMnJstSDMoHYdgIdBknMTMGlI1u+v1g+mbW71+t/CjA6u23V2/fXr19W8bu8kueHHpGseGQ+zXK0u1aWEDB0q5LacBHPFWSjKq3RReMIc7YV7RkshhPtNNOjCdOByPl8UMFkyWiLqwFq7i+HXOdWwL+RZN8V8uN4MZL+7ddStVHGPNxbsc5EB5ou4yViSKWhD4oLvYe2m8XHqKZPx0V3kb++e6Cm1vbPK93m0ZYCOJjxSOmJl4ERhXimC1VdSRZWPvB77qNlPqWR2D38b6X8mFrzWaRTISxym0nngxgKBUQRgZSPthdrDHTZAAgSMQCJ68VE1VC1o3NUvOM9Jg/5vAI8/UMDIdWTGX9hUXRHY2l5oY/Ou8KI5b9TMSDkE+C3m856XMUedqoaq6nM2fVtM/C8h2zFRyAz3VRwiKJBsWWdv4eWZiAp2WifPAycEyqWXEbd1lLawIM1PB+YB0vjPwlTbNF1iHdY5wof8w0bKVF18SyRYZSEaOYn2qNfCIRExMyp6gJU+B0iEhB7JvMneb2fffgVdFjHbvHahcB4WLkrHHReHNzjel1cW81j7uldDYHMQtbTX2u/CRk6q8/SRa+olnkY9iosqNXzArtO6UU64k/lqEccZ+FvVuVaNwUOncdw8QS4uLAttdargpzWrSF9t9bNnpV4Ch7uPas8BxY9KWNtv3mxk72ZXtjDc821bDgqX4RUB/GF4CBRv2MlRcDasTFgY16ut/d2txWY1JD6Zwjko4GSbNGzm/pMW+BRa/oChX70JFucfRkSXp5CvQVLRzM2463ugFlfC+/tuB+q/hmIYh0q3wHFUoJbGR4vhW//Pxv7knDuKVi6lI62fBzzxcCKYRt84fySexkMSoXzmhJTtmSVDiDFTS9syByT2vVZx33q8Tozjs9rXdaQpnubff+DSwoBmznlTdeNxvZcm1Xc1Bj/TC+OHGrsAacpervuNI/rN/E9T5qC673ERdHgQtc7yOScL3/hdf7e8g0tA0i8CgP2okXtxMYiSAu8CgPHuVBHTsV24tHec4aF+d2lGdDQg0TTAj/I0ww7bRqLmRQt+YoI1eVot2Uy02f07XSrtpamDe2uIclAQfhl65F80X00z5N63j6tDdlIuj1+3f3sxnNkbAVSrxQGlWhOeNJLM0YNC8p30+rkwLul6937SfdKy+WvLgvsWzB7ecsbt1q1gvAMB6WN7V8lJQnzRaqYHuDb6w6e2vlX6Xl/zvHwoWVeGs72WRXJvelQ+5mcKm32sh4lyjC393YLQmMhs/f7ONOBOLikDcmbTePjTa9ywzq9dKYFr157gUt3km3Cek5u9yozSMovemWpbXrY0p3zQs8urrftUt6tvQ/vhRDXrP90UQcW99D9QcE5PvEmFTauTuQNsO7eOdRqYD+m9GZuct9fCmCZbR1YC/dADBY0L+ZLBb0Y0E/FvRjFhBjLIy9EReYBcQsIOrYy+sYZgERF19DFvAgRhsP+KPyHqPyYkCNuMAD/ogkPODfnDcs6MeCfrQkX915KyzoP2hyAgv60Sq0sgpY0I/rfdQWXO8jLnC9j0h6cSTheh8L+vEoD9oJjEQQFy8cieBRHjzKgzqGR3kQF1/pUR4s6Ef4n06C6dQL+iu3y0sXyjfzsrQ5kbQw6JHD08tXqIF45EoK1yZ9O13UWAXwCKGM3Tfc54MkLf+/n/+FW99WhZUCfK28sUOHXGnjwXMsdaJgJ18bsn1RCphhnp8YORzuxfu3p1GKnfcpTvKY8XavAcXqRqxuxOpGrG7ELVGMP09nWY5bomeNC9wSxS1R1LEjtb24JXrWuDi3LdGDGG087YjKe4zKiwE14gJPOyKS8LRjc96wuhGrG9GSfHXJZ6xuPGhyAqsb0Sq0sgpY3YjrfdQWXO8jLnC9j0h6cSTheh+rG/EoD9oJjEQQFy8cieBRHjzKgzqGR3kQF1/pUR6sbkT4n06C6ayrG3eoFqz8c3/LP/F3NmWFruApN4JFWdSyOfg8SlETWdPQsG0qSL8x7XjByYaBrPcehpI5yfIoZn6VEGr7eqF8Sk1mawpJHLejUPXnIvNllbUJpr1uTGHGCJ3i6awVcJ/mrHGBGSNE0slmjMpc8YIsZm0wa4O6itEA4gKzNpi1QR07Fh3DrA3iArM2mLVB+H+RrE1b34030631x5vp8Ga6RjfTlVycgWV3B5U8lt2h123ldU+17K5Fufri7uUXPrWxJ8FhYIOBDQY2XzawwYwP7jqeqKPHjA/iAjM+mPFBHTsd24sZn7PGxbllfA5itPe4MsfUE+rhERYM4dY4bo2jVTg+q9B+a7y+Lm9ZbnfIq1nbX3lTrxt7KolCRTh+RaixZeswWipKDgHVfq4MQjlcumi1Q4U0cABnqSAOJ56RZe5kIU37olP5geUYXOC6JpbfpYH85zw7nGYh/gofBcnupH/Mn28zz7MgKSBpZ6WaVxum7H8VzH9BwNMXMrYoSsLQk1YffRllfTK1dUmU+e973O04e3OBO82Ii0Pudli7WcbCWsOqOwfWqcKTl7eq1WiqM/b1X2ice1z4i1zfFRE08KbW+xSD0FXPtM4h+lv0t2hXj9uuor9FXKC/PVF/O2SPUnE7J3u4PQEV8qgVsm4fZU8RxvbCW2H0xwyTOd2yTVgIqvr67nbB4L7uVnJPcmGVRXUSewIggMAGR0nAQfjgRVxHzPhjG0u5GfY0/xM8Bcwfu5bZU2XzI8vWbQOpfTjdCAwLmGENjHCpvbm2c+dmMTfiCmO4YQpfDKH7kaKCzwlXEHgrQlgzEqtXzOXPoXb/+ebtt46Yg0t7htaXGEuSLTisJl6KihvX4sZ+Y+m7Pe0rEHosd9H1OhCsHOytChsWDd+4I9IKUuYKrqb2G9+6m/0GUOORsqvhyL/+ookGX4qAcAPODoimpirHV3ubmBLRbATtaZSfOXbqJ+O4aQygwBlHKbwAIiaannxfCqHRnv+PPIQPrnkxYnLPnRgKQtloWZ54YMY1WOj+w56NHwMfjWsQ992b7vyzGxRx/rr+fHcWIH2SY+EFEhaRjhQmf5PmZgI8YiO4yroNmIZNAdbCNNj32XR7IQzzg624c9E1t1sMzVuvSr2u/ZrsKzvg1sU5R8RNty4yce64SsLZfuEDFfkgozbKKHOxmYu+WfQvcRip8628/XXZv3huIr/maRTLFhPcG66ks9nr1aZbpNMLlDbxm71y/7gFw1gGtiIOnBYwa6Dp1Wo6vkM1qEenUndT5zB6dGxMrHtXV5qJYCCfL9lAR0yZcHLpy4jO7m0fP1HclpLdTd3UXsf8F7D/e59/feOPIUr1Lt9oOdvpgw7lwn42PYa2Uv1Er4ntS67f/0x+gYkrdbK/WWLGUvE/XWh2SS4ufku0IQMgXBAzBpJikfTpdcy/sR0nMkmth8di7j3ApE8vLug8SqLXeXpWLI532qP/ywj0+7rfv/mbQxUXQ5e6mE/CgPkPIOzK0Yoy5fv1Zfeyuz4aQd7FIOwIbmLw+TCrvyJmzAxJ2w5AuyFcf5/J3Q3YDvxJKlfi9cTN2A2I5G5JJLGSI8WiiBlbWhBOLmkaXqT3N9sAmPsgdLrsS0f9XslYcTBMTdzAYqlNlF5EnbVY4ovcspEmv/58c7s6quk8iqE9enHxR7bIIu9BRVxbceiLix75mCP1K9fmI5Gq8PA6iLj4SBdrUAPP5ioOGXehd2ZNUyDfrZ0rue/QsdTGvppObXT0QYWzmX38OQGVIjXg2trsIDPwFaOw1amprScPMLEFrloq42ZFgU5Co8nAybeU1QeLcmp70MUt4LZOsoSDZVOPab9h89jGw82apoY03/Y+s8HOed3du0jYKZ6VUNrp2vchzvOeKxS8+qTtUug+Z2F++uGWzmb/B1VAhUQ= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiment Tags LIST

- - - - - -**Required Permissions**: `Experiment List` or `Experiment Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all experiment tags. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    experiment_tags object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/experiments-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/experiments-list.api.mdx deleted file mode 100644 index 1325c06c..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/experiments-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: experiments-list -title: "Experiments LIST" -description: "**Required Permissions**: `Experiment List` or `Experiment Admin`" -sidebar_label: "Experiments LIST" -hide_title: true -hide_table_of_contents: true -api: eJztPdty2ziyv4Liy+54tbGTzNac4zdPanZ3aiczqdizL7EPBZMtETFJcADQisalfz/VACWSEkVSlBRf0g+pyBTYaDT63mjowQtBB0pkRsjUO/dOTj7CH7lQELIPoBKhtZCpPjk5Z+OfvmSgRAKpYb8IbcZMqtrDizAR6dgbeRlXPAEDSnvnnx68lCfgnXsauAoib+QJnOePHNTcG3k6iCDh3vmDZ+aZHWaUSKfeyIMvPMlifBTwOPaN9HlgkVwsRiVQqcw6yPqCriJg8vYzBIbdwZwZyfAdZiJgCnQeG81u5696YmJnXZ/f5zroXNatlDHwtArNqByqsDI+hU44IjUwBVWF87oKRBhI9BAo/1iDojgSUPtysg5NFQzinU94rKGJ4GMRjpmcWCpDySEm4obNZc5mHP+SbApuJ8r5mJw0bsYS4yqWcpYij+2G3kXKuFJ8juiNcw1qzESoV3zRwRP2VZzRkrkJvQp+BvjmXnSht8IN3z4ibny6F+UMnx4POZ5lsQgcQ+yDZAXO8ZDNU2F8HLAfJy6hHA/RTMG9gNnOaLJCd7F7HufAZpEIIhZCLBKRcgOazSIwEahSsnkcV8U+5Iajsfica8M4m8CM6QwCMREB04YboY0IdG19kOaJd/7pbPT6pqaXkowHGwq/cwEmz2Kooc/jWM60xRhJbbGZM87GEyWTMeNpiH8YOWaKp1PALXJz262ZiNiAwk1hJydXkdAswaXdAss1hGwmTMQ4K+jNLJp2k1+PT07atjER6c9uJ9+MvIR/Kf9Y3+A0T27X9zeQ6USEkAYbVuTrEKic/wkTSYtpiozHB5CpIq9VMNoRS6TTJblWS2eZ1MKIexixFKYcP6Eg5Gn5vqlIij4wqVYEKcTJE9WJ0VMr0PNG3hI/76ZOL+se+NY6+4nQCTebTtwgDVLnsIJkE6mq9FgufXxp0WAfEQ32vkBjzHgMyhyIaEsPrSZS+CTP/BQghPDrL/udDIG9c0iwXy0Sx180z0OBUvyI233FFbqGFwUmX3HHC37X4k/wFfAgeoxtL7j9UvwJ7KND4vgrL33w3Rac5nHcw3Rvi5QOQE0F96A02EhCqhBUQ+gRC212oMTufnvKCqerBVF0mVzA40wT4lndfxsfcYWRqclVCiHLQDGMC3vHRE1B5DDUFWQKtONLxAshbxJWW8q6XUCc2/G8QWR0JlMN1i69OTvD/7bb2TVP0gXyGqkRyNRAavD1ipt/+lkjjIf+rrIDibZQyQyUEQ4zEXYF3aOC5G35AgPa+CX+3mJUilkj/ESkIkH5QfjoG3dMoPI0xWcL3NR7iGWG8/jcNL02kSrBb7yQG/i7EYm1+3kc89tVPsLOqvaFILPhACrLwy8WI2+Sx7Ev0wLk+ugeU1Rg3HMleNoGqGEzzqyj6T6/XYy8mGvja4DUF6kfyBD2Ileqllg1hXDVqav8USETopSBCiA1fAq6CZOMGwMKpev6Onx4s7i+Pl37UGOrt9+fvn17+vZtE7rlTL6c+EbxyUQEHcJydoZsARC2UulWTIUTkgKqv8MrgQJuIOy/E5V3bufdCgGTl+K+hk5DTs8q2MXI4/fccNUEdYOebqg/ETH4eRZLHvq5itvF/jRQMvtdxaevz86+vD47O339KnNaYD8y+JgQ87fovppuCiHjyiSFBt6O6Xuu7sAUKgoSLhpXtsLLjVggCwhjAfyu0XIMQzLPwt2I0bA9SxjEI0+fR8q96olkA6lrvkgb1tYNL237XzSrvorYLFN6A72NXh7Gcp27YQ42ySgnTOYKQwilj8oXG6I4zIY3b2+HGSc1/6xEeBf6V19PhbnC4VW527bCmhOfKZFwNfcTMKrmx+woqlPJ484JfzjrJdRXIgEMqX6U8m5nyeaJzDFUmjDceHYLE6mAcYyj7zBHGXHNbgFSlvDQ0mtNRTWAtWtDaK4KGwm4h2U8A5MJkqnp/SLp2JRkxF26S+Us9W523PQlF/naqHasHxZWq+mAx9CHDyAQuk7hIoFcGYn7Z4NkX8tcBeAXzDFvR8VbrNho7rvkT/cLR5Tx2sofUzUjZx3TPGa5CiKuYScpumCIls3OGcUDJzVyxhKeztkSoraJGpQhJlOG3xTmtFa8pMDkxVusYR4QBSMvmi9a964V6U1y77SP9lzH4Kzndidmpau9QKggj7n6678kj7/zCs/H8GnrizhguKKvv9yk5/U8iGQspyLg8fmVyjUlhV66jD1a9El88aT54oC6FzVXizqt60L8d8Wn39UwKh5uPKs9t+cEv67Sxjm3voRfDlfW8AVLDSucuoOAbje+xhik1F+w8JJDTXxxZKXu8t2D1W07T2po3HPipCfDSYtexq+0mFfAk++8NSj40IKunIRpY6nKGZAK6LJ55juvCmpH3LoWVOBdzrbCfif/ZkUIlyrfQ4QcgK0IL1Px5fTv7ZOefkvL1jk4xfIrz1cEqblty4dFn8leDtrWwJk0yXPWJC3GYI2bfkMmsk87xWeT79eBeXtnegZnWmLpctvn/wYe1h22l1U33lQbRbi2rzro0H7kXzxzrbDBOKXo7xnpH9duUrxP0kLxPvHFk+ALiveJkyje/8rx/gEqDUOdCDrKQ3ri0fUEeSLEF3SUh47ykIw9F91LR3leNF+8tKM8WwpqVGAi9n+CBaa9ouZaBXVnjApwbSXabbVc99zbaO3q7IV5g809y8tvmrar2kT/cO25Pp5r7/yBp+H59fWnm8XCq4DADiVRa41qkZxonkkTgRYN7fuuOykUQXO8i1Par/xMinpeohwhcDrkWxvN+iEYLuLmoYhHQ3vSYiUK+DYEBsXZ32j/amz/39sXrkXig/Vkn6xMZaZjZjOE1DslMn7LFRO/XWJKgrzhl6/2KRNBfDHcG+4uwe62j72S3k0K9aJUpnVrXvnCq02wldMrernXGLwSbNstSxvXxzRmzWs42r7fjUt6drQ/9obMjvRHH3LsfA/VRwjZj7kxjtqVO5C2s3f9zqNGAv23gLOwl/sEMg1Lb+vIVroHw1BD/3aw1NBPDf3U0E9VQPKxyPcmvqAqIFUBScYeX8aoCkh88S1UAY+itOmAPwnvUxRecqiJL+iAP3ESHfDvjxs19FNDP2mSb+68FTX0H7U4QQ39pBUGaQVq6Kd4n6SF4n3iC4r3iZMenZMo3qeGfjrKQ3qCPBHii0f2ROgoDx3lIRmjozzEF9/oUR5q6Cf2fz4Fpufe0N+aLm8MlC+XbWlLIK4x6F7A7PE71CC9F0qmdoz79mHVYxXCPcQys3PY6cPctf/fLH/hNsCusEYG32hvHHkTobTx4Usmda5gL1sb80NBCrnhfpAbOZkcxPoPh9HIOx8cn1R5xt+/B5S6G6m7kbobqbuRUqLkfz6fsJxSoi+aLyglSilRkrEnqnspJfqi+eKlpUSPorTptCMJ71MUXnKoiS/otCNxEp127I8bdTdSdyNpkm+u+EzdjUctTlB3I2mFQVqBuhsp3idpoXif+ILifeKkR+ckivepu5GO8pCeIE+E+OKRPRE6ykNHeUjG6CgP8cU3epSHuhuJ/Z9PgelFdzfu0S3Y+nN/5U/8vZi2QtvwVFnBqi2qHA6BSBzXJKgaeo51hAx6w85WmGxZyObbk1hyS1mRZDxoI0Lnu34sZ05lDoaQZ9kwCG0/F1ltq+wsMB00MUUVIzKKzydWoDzNi+YLqhgRJz3bilGTKV6BpaoNVW1IVskbIL6gqg1VbUjGnoqMUdWG+IKqNlS1Ifb/KlWbobabbqbbeJ9upqOb6XrdTNdwcQa13R2V8tR2R1Z3kNV9rm13A9rVV3cvP/KpjQMRjhwbcmzIsfm6jg1VfCjr+EwNPVV8iC+o4kMVH5Kx56N7qeLzovnipVV8jqK0DxiZU+mJ5PAJNgxRapxS46QVnp5WGJ4a7+7LK9vtjnk16/Arb7pl40AtUSQIT18QOnTZJhuVglLhgC47d6hfs6zNeEQDqg0P7s5veXAHaUgx/MsXAorhiS+Gx/DdJabBLU8V+70e1de+2lSPO+j0NUhY1JIGjhC5KMjiuW9kE9FWu4dfjFonKAllswgb6/lVGqhO5+Ny+uVb1vCoUXUv28WDZc1vWZJ2AuCN1q5W0IYr/F/B8hOEwn0hM+TaPI59ifIfyKR4p1ATtqK9/HxDZutlqycq+xFfHDn1jHqzCYWNgW0XwGxChZlf1art3NSl7Ltn6G2lV/ai8u4aCXqYbLQ+2yy1s0ybGJK9JXtLevVp61Wyt8QXZG+fqb2d8HupBO7JAa6yIYF80gLZldQ+kIexO/HWEP1nwZMV2cIhPAbV/lsKw5zBQ110Z59U3Crk6jzzU4AQQnSO8lBAGoCfCJ1wE0ToS9kd9rX4E3wFPIjsyOKpwmJ1OXqoI3UIo5uA4SE3vIcSbtQ3F7h3dhcrK25Rhlu28NE49DBUVPBHLhSE/hoRNpTE+n2f1aaAs/998/Z7C8yyy3CENkOMEuQADNuBN3LFpR1xiXOUttvXgYJUR3IfWe9igrUuiza3YTXwje1XUeCQq5mazjm+t9es3kKHRSru6WTv/qKZhkCmIRMGrB5I+6qqCl7DdaIDovkUhsNobgCx4iezrK8PoMAqR5n6ISQ87duGVBKhV2HhnyKG3+3wusdkn1sy1IiyVbPMRGiiDl44+x9sVIpATKMOjvvhzdly2i2CuPy6u9mmcJA+yyj1QwkrT0empnqt8XYAIuFTOC1eu+UatjlYK9WA3xfb7ccwqS625QJcOxxTDP1Hr1O9a/wG7VtfoNTFS/aI+6YuCnLuGSXRbj/y6baqk9HpZTSZ2MJEX67ebzAYzvi2XsVdvl8/xFaLeRaL4sxtJEPs9AXLUBx1nXdaLZ2PPA3q3nLmpwerd8+9yJhMn5+eap6Gt/LLK36rE65MPH8VyMRb3OA7Qa4Etsd+erAUusjEfwD/vKl+fRlEkDj2rQ4qieYejDyR4rTuaO1aR6d3wfBddvHhZ/YfmNv2TfzMcxNJJf60Hs4rdnLyPteG3QITKTMRMLel7Nq7yMTf8cW5zJ0Q+jwT/h3Mr72TE2/pbHgXVXhIFou7d+79XwHg+lpfX1/+zW6OSCe2ArCk/fJc08hDUjq8X786e3W2uZqU/ZZBiiu4zCAQk6KnlJmIG+bG3oK2S7j4saC7XTAufCaVbVudCRPZBbHKXrJMyaniScINtkvF81ees9LuTnr0I0UAqXbRk1v1ByUzJcBwNbcLy6Q2ibtcvxjxU2WCX36+vFpf0cPSEfDOvZOTj0Wcwj6ASoRGUuiTk3M2LsGwX4Q2YyZV7eFFmIh07K3COANfzGkWc2G910IhOQb+VDv7cTPyIqkNPn54QOfidxUvFvj4jxyU49BQaFR5YaEfR94dsqGnAZWqt/rxAWzPbhi8dbnYlu/0KruDOXb2a6mM3ToFOo+NZrd2ExrXVOAgbYGkHYNyqM910HN4hr5nv6FOae1Fh7EIx/ZygggqPOm4ei5zNsPgxEg2BUegVXCimZx00Kgc68vJcDQvUma1NKI5RkUwZiLUq23rvWXFad/heKyQwPPGA5FwZ6oPQwvDp0OxwFOqh0Gi0l8/EJlah/6BuAR/XAWnHIjS6v19EGKFn8csADaLRBCxEGKRiJQb0GwWgYlAlXLG47gqhJh+Q337GS0kZxOYMV3YHqYNN0Ib7MxpXUnmfgBkr3WYPIuhtgoex3KmLeJIW4vUnHE2niiZjBlPQ/zDyDFTPJ0C7on7lRO7F+7GDdwFdnJyFQnNksIHyDWEzkhyVmDOrDmwu/p6bA1/m8ZxP+Ty2GsNZDoRIWZ+j7zecqLDCI4W09S6NhZ1u3J0W4q1r9bBlnfIjNjyChnk0zwt3zdVD+fg667ieWgJre93sWZ04qouW4H72OUz2UfUXux9kbcfM1u4OPyqG4sEj7n8dzIE9s6VPdivtuxxrMVvFFceb9VXXKE7dFFUd46+701lpEdneczhs4+ufHBkhl+rlfX0jNXeHkUPWinAwBGsayxVCKrBl46FNt3BRK8IoU2JFwmXFmTR83BevMt+Iq7VHbZOP16jpMDkKoWQZaAYxiPdjv6eTm0T8goyBdrxHmKGiGySV1v6ur1ArDvcofXg6qZIENnM2qcbm6a36QyMP907F0EAWdWpqDisp5811mluKjmbf/105S0W/w//fQ4j -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Experiments LIST

- - - - - -**Required Permissions**: `Experiment List` or `Experiment Admin` - -## Request - -

Query Parameters

- -An array of all experiment objects. - -
Schema
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>= 1` and `<= 3`"} schema={{"type":"integer","maximum":3,"minimum":1,"example":3}}>
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    = 1`"} schema={{"type":"integer","minimum":1,"nullable":true}}>
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    primary_metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • applications object[]
  • Array [
  • application object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • variants object[]
  • Array [
  • ]
  • secondary_metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • previews object[]
  • Array [
  • ]
  • preview_variants object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
  • notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • new_experiment_notes object[]
  • Array [
  • reply_to objectnullable
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    new_experiment objectnullable
  • ]
  • favorited_users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • alerts object[]
  • Array [
  • ]
  • sample_size objectnullable
    variant_screnshots object[]
  • Array [
  • file_upload object
    file_usage object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    avatar_users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/goal-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/goal-get.api.mdx deleted file mode 100644 index 9c4b66a5..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/goal-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: goal-get -title: "Goal GET" -description: "**Required Permissions**: `Goal Get` or `Goal Admin`" -sidebar_label: "Goal GET" -hide_title: true -hide_table_of_contents: true -api: eJztHV1z2zbyr2Dw0san2k7cmd7pzblpc71Om0zt3IvlYyByJSImARYAbasa/fcOAEoiJYqkvhrb2YdMZBJYLBaL3eVidzGlEehQ8cxwKWifnpz8Dn/kXEFEPoBKudZcCn1y0ief3kmWkHdgPhGpir8uo5SLT7RHM6ZYCgaUpv2bKRUsBdqnY8mSnyPao9yCzpiJaY+qAj7tG5VDj+owhpTR/pSaSWZ7cWFgDIrOeiu4XcdAeETkiJgYiEPAxMyQiczJA9cxMZKMwZCIGUZGSqandHZrB9SZFBq0HePN+bn9rwr4kvz36v1v5P3wM4SGhFIYxgUXY8KIncI32oE8pT1q34EwFgTLsoSHzII4+6wtnOn6XKQDaQmkZAbKcI+Fhdreikf1VPHUXbzRRnExpj0KjyzNEvsoy1UYMw1rNGzqdOkmS0ZSEaNYeGcJEMsHkjIxIXOImjAFJGURECmIfSNHROaKlMih7bChAmYgCpipG3UkVWrf0IgZ+M7wFMp9hpN24jAVxvweyiQaSpkAE+VJjViiYdaj7J4ZpuqgijxJ2NC2tey4aBqMeAJBniWSRUGukmbSnYVKZh9Vcvb6/Pzx9fn52evTTIz3J0OQa1BBLR/0aMoFT/OU9l+7Vc6YMmnBm5sx/ZWpOzDcIwcp47UzW+DlW8xmPWq4cQA+as+EnZCc9WieRdsRoGZJ5jCQL544XzSuXSPS6+Teah0NG+tSS6YUm1i9YyDV3cTxRgb2spqGXIV5wtS3Vu+8ov55YNi4saNtsLugr3auk/N6EsYykWMesqR/rXJtUPa+8D22s+ytUrvXkSAoe58JXxxQ9lrJ1SBOq7LQ/rtm41cVjIqHa88qz4Glf7fQtmNu7GRf7i6s4dGAEgucNuy2rcz4CmOgUH/BmxcNauSLIwt123gPcdvMkxZX5KSnzEmzTspvqTGvgaWv6AoU+9CBhscMFLe4N7LUstmOerVEh9edVKYBbYLSsDOHjWIr7q8NS6INMy0DqFyIYi0iuIdEZnacvaSxNkztC0FmuwMoTc++mPXoKE+SQIq9PhzmMO6Z4kw0AapZjPMeTdmj/30x69GEaRNoABFwEYQygr3IJdQcK13PE4uhy/xRIpNFKQMVgjBsDLoOk4wZaw/SPh0Moumb2WBwtvKjwlYX359dXJxdXNShuxwpkKPAKDYa8bBls5yfW7aAirBdp9KQj7nfJAXUYIsuaJC+bHWxC5JonH5dPNLRGC0L0TVSdz6guo65Jkvdbo/lSl0tNoKbwPc/3tnafJ7bYW5PLvX8rMyb4sfki4M7/8pjtbs2UMw/ny28Df3L3QU317Z5ed9tmmHFiM8UT5maBCkYVbFjttyqmx2ApQF/OO+0qa95CjZ84K2Ud1vvbJbKXBgXl2DBDGEkFRBGhlL6Q3SmyRBAuGNzZ2xVRVQNWH92xFMIjAxYGHO4h/n3DIxGlkx1/YXlohuaSc0Nv3faFcas+JmLOyEfBL3d+nTNc1GgjWrGejpzUk2HLIEufAAh11UKizwdVlva9btnSQ6BlrkKISiYY9KMCp0t2GhiRYCBFtyPvMcrM/+SonmjZ3yvE9SdTzAT6WNG+v8BFlWVx8tSiiXR+asTfPNjEPkg9nLMeTHa6JpDv90z1tBrjPPeMswhTtBaOGeun5eywo/f8RytwZVYbADvTFx7TtdshFah+sZqCZZHHERYq1nL3pjpgHqFMKD9KRNRfzC4uZ3NaAmEVXW8omMbGD6eZNLEoHmNH8iruYiH9ZaEHdK9CjLJq96oZQtuh7Ps5gRlEIFhPKlvavGo0XOzBQfb3hAauwuDNTui1o+0d2hOJTBwZ14te5KXnPXj4qllytJIx/wA5FJvZSK+zxXh769shCS6zV66tMZzXOSLfc5x2w347dax00FdnUC9XArTamhP6QWtDLCR00tyuVObe1B603Hd2jlECbNa5F2LmtOeLfVPKMWIt3zLdCHH1geav0NE3ubGeGqXDtM2s3f18KyWQP8r4MzcKVEoRbS0to6spTswDHqG0DOEniH0DKFnCD1DaFOiZ6jsGWpErdbWuZrbN3MgXsPcc3j48qYOiHuupHBt5sp/rqxL8WV++Cj3fqTb+ZlbaM2LbnZyj4648rFxUucK9hJ0LhzrIJBsYm0Q5kaORgcRvbvDqOWdD55PyjxTFzqGZjKayWgmo5mMZjKayWgmo5n8xM3kPczORgdkOWL/hdinTnPW6ddlcwh5yhJPdFari+vaekKGnWFnC0w2TGS99yiRzBQnyCxsIkJr3yCRD17S7Qwhz7LdIDQ5sMv2ectmrjO0FxurXYccyGZHhfH0FUaLzl9nxqVCKXFAmz14KAdCZcQjGprasPCuP2ThHYgIAxle/ibAKiPIF8cMZNg5NKGkv1frjlRerYvHLWT6CiTrBJMGjvCFryBLJoGRdUSr5OX2GgdYEsp9XqzN5zdpoDxcYKfTrXjAen7wgXQXW4RFzr89/AagvZWPEJch7WpHzn9BxP0LmdFFrrEr0JgWfQox4fx289+3qLZetnjC+DvkiyPXUbFysw6FtYZNrpJ1qPAQdK+W0Sbs20forKUX+qLUd4UEHVS21T6bNLXXTOsYor5FfYty9WnLVdS3yBeob5+pvh2xe6m4XZMD1IbDDfmkN2SbU/tAFsb2xFtB9KeCJ0t7yzZhCah9Iq6OPG3/pGRWWa7Os0AARGAvwFgklqZcp8yE9iIM7VY40PxPCBSwMHYti6euYt2y9a6G1CGUbgqG2TC9DkK4PhnHrp3PNFnOuEEYHjdo7ktRcX7tSbBChDUhsXoyXsnG/debi+8dMMcuhyz5twS5A4bNwOujcl2LKzvGUncHOlQgdCwPE13ZKZasyWxYJpi7qDwFHrmKqmkd43sXkDCEFo1UnGiTf3+jiU/JIsvKlR1FVQmv3WWiB6LZ+OBltNz2k1nW1QZQ4ISjS3pPmegabLkkQqeDhZ94Ah9d86rF5J47MlSIslGyPPDIxC28cP5PG44ZAx/HLRz3g6tp4IbdsBHnr9uDcwsD6bOMRRBJWFg6/jKj1YppdSnvKRvDWdFtyDRsMrAWosG+L5Y7SGBUnmxDqIhrbl0M3VuvUr2t/RrtGzug6+IlW8RdXRcFOff8SsLV/sJRoGUjo9XKqFOxhYq+WvSvURhe+TYGrS37V6M3y9883T47auNE24JL14/K51W9t7r3YxE7t3fWeMcw2l1tEUxzWeuPaS6Y5oJpLpjmgmkuL8rA2THNZTU/pdDstXklx8lbWVgglfvD5g/35fzGGxyR5Z8vyzdKrRVuWu6Gve1VNDTR0ERDEw1NNDTR0PwKte5zzafeVWTgxa64WzBAEvniqQZI4sWuXzUn4cWueLErXuyKF7tWqIQXu6K6wItdkUfwYtfuH+V4sSte7PqStvAXv9i1zk+HF7stW+DFbnixG8rTZyNP0Y+LfIEXu1Uwxovddndofs0Xu9VZhnixC17sghe77LdNsLA7FnbHwu5Y2B1tdSzsjoXdcRNgYXfki7/fkYGF3bHQLBaaRfH0JNQW+t9fNF9godlnUGgWC7ujvkV9+6zkKupb5AvUt89U32Jh969nQ2Jh92NO2z/Bwu5Y2B0Lu2NhdyzsjoXdsbA7FnZHi/iJW8RY2P3rWW0s7L53Yfc2Bm8slLqxft9eRUkqBWBbw9fbK9iuVZjdVIp2EUu+gox9MpsV2MQysjUxwfgMxNjuO0fjs6n97+fI1oDQoO6dXLmZOq3Zp7Exme6fnWkmoqF8PGVDnTJlkslpKFM6u3Uh+7nitpbkzdTx92XGfwH752359VUYQ+rXptxoSR7/oEe5zYyMfSXDlcw2eklsX3L54WfyC0zISPrfLDexVPxPZ5+ekpOTX3NtyBAIF8TEQPyGJAN6mfHvbMeJzL0IDVjGgzuYDOjJCZ2bivSyDM+SxeFO+/T/BYDBQA8GV/9wq8PFyJ3fzCk/j0rr0UXuCH19en56vj4bQd5nIOwMrjII+ahIEyEmZqbIJx+CdlO4fFvQ3U3YTvxBKlcZ9YGb2E2olI6uSabkWLE0ZYaHLEkmp9TbWD721n4F8BCE9t++ftYflMwUB8PUxMeYS21SH0RctLBMRd79eL06k+ncfKN9enLye/F1ST6ASrm2JNAnJ33yyXcH84lIVfx1GaVcfKKL720Dj+YsSxj3OfRec3h2vSlEQo/2PcPS2x6NpTb21XRqLcGPKpnN7OM/clCOAwtB6zTUzZRGXNvfUaHaGqbx7XwWr4hPmHelaWMgDm23QBOZkweuY1vzdgyGWL8EGSmZnm6az5zVheXzIoaa0h69szuBFrOa3Tqr3PG/xdm/vAxDyEypWylJ6eyztp9lt6V9bhdpNvsLl4UfWg== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Goal GET

- - - - - -**Required Permissions**: `Goal Get` or `Goal Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a goal's data. - -
Schema
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • metric object
    tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/goal-tag-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/goal-tag-get.api.mdx deleted file mode 100644 index 04ac081f..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/goal-tag-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: goal-tag-get -title: "Goal Tag GET" -description: "**Required Permissions**: `Goal Get` or `Goal Admin`" -sidebar_label: "Goal Tag GET" -hide_title: true -hide_table_of_contents: true -api: eJztHdFy4zbuVzh8aTfnJtndzvTOb+lNu9frtLvTZO8lzmlpCba4kUiVpJK4Hv/7DUnJlmxZku34NsniKY5EgiAEAiAIgHMagQ4VzwyXgg7pyckf8GfOFUTkA6iUa82l0CcnQ/LpnWQJeQfmE5Gq+O8iSrn4RAc0Y4qlYEBpOryeU8FSoEM6lSy5YtNfIjqg3ELPmInpgKpiCDo0KocB1WEMKaPDOTWzzHbkwsAUFF0M1tC7ioHwiMgJMTEQh8MVmxITM0NmMif3XMfESDIFQyJmGJkomZ7SxY0dVGdSaNB2nDfn5/ZPHfgF+ffl+9/J+/FnCA0JpTCMCy6mhBE7E2LY9BvtwJ7SAbXvQRgLhmVZwkNmwZx91hbWfHNO0oG1tFIyA2W4x8RCDgybdrfkUTOF6p21UVxM6YDCA0uzxD7K9CyMZSKnPGTJ8Erl2th+oQJmIAqYaeo+kSq1b2jEDHxneArVPuNZN75MhTG/gyrWYykTYKKK3YQlGhYDyu6YYaoJqsiThI1tW8sty6bBhCcQ5FkiWRTkKmmnwVmoZPZRJWevz88fXp+fn70+zcT0cDIEuQYVNH6aAU254Gme0uFrx8gZUyYtWGY7pr8xdQuGe+QgZbxxZku8fIuF5QNuHICP2vNFLyQXA5pnUYUAdWoPehKkhIF88cT5ooFsq2/XivRGPyu5dKUpU4rNrKQ3kOqegm8bT9qX+0tEr35aRWKuwphp2NAwbZ0uvBqYSEWMYuGtVQ2xvCcpEzNSQtSEKSApi4BIQewbOSEyV6SiJDSK3xe+zPYWvz0I0LqEkS+eNF88ovjd7TsaNm2R1TTkKswTpr61JvU7b7a/csYlsPS4Qr4+9ivqx9zayb7cXzPAgwElljhtMXZ2UiU1xkCh/oIXLwp15IsjC3Xb+ABx286TFlfkpKfMSYteym+lMa+ApV5NV6DYhw40PGSguMW9laVWzfbUqxU6vO6lMg1oE1SGXThsFFvbgm35JNow0zGAyoUovkUEd5DIzI5zkDTWhqlDIchsfwCV6dkXiwGd5EkSSHGQ36aEcccUZ6INUMPHOB/QlD34328XA5owbQINIAIuglBGcBC5hCqx0s08sRy6yh8VMlmUMlAhCMOmoJswyZix9iAd0tEomr9ZjEZnaz9qbPX2+7O3b8/evm1CdzVSICeBUWwy4WHHYjk/t2wBNWG7SaUxn3K/SAqowQ5d0CB92epiHyTROP26eKSnMVoVohuk7u0kvYq5Jivdbg/MKl0tNoKbwPc/nn+3nOdumNuzRV36a70pfky+ePSzl+pY3a4NFPPPZwnvQv9qd8HNlW1eXXfbZlgz4jPFU6ZmQQpG1eyYHZfqdgdgZcAfznst6iuegj3c/1HK251XNktlLoyLHLBgxjCRCggjYyn9QQ7TZAwg3NGNM7bqIqoBrD+65ykERgYsjDncQbmfgcnEkqmpv7BcdE0zqbnhd067wpQVP3NxK+S9oDc7e3g9FwXaqHas5wsn1XTIEujDBxByXaewyNNxvaX9fncsySHQMlchBAVzzNpRoYslG82sCDDQgfuR13ht5l9SNG/1jLd68fddo50BJIn055bDfwGL6srjZSnFiuj8zQm+KzZ1T+W9OMgx58Voq2sO/XbPWENvMM57yzD++WEnaB2cU+rnlazw4/c8R2txJRYLwDsTN57TDRuhU6i+sVqC5REHETZq1qo3Zj6iXiGM6HDORDQcja5vFgtaAWFVHa/p2BaGj2eZNDFo3uAH8mou4mGzJWGHdK+CTPK6N2rVgtvhLLs5QRlEYBhPmptaPBr03GLJwbY3hMauwmDDjmj0Ix18PFwLTtmbV6ue5BVn/bR8apmyMtIxN4Bc6p1MxPe5Ivz9pY3SQbfZS5fWeI6LfHHIOW63Ab/bd+x1UNckUC9WwvRVbT6VF7Q2wFZOr8jlXm3uQOltx3Ub5xAVzBqRdy0aTnt21D+hFBPesZfpQ46dDzT/gIj8mBvjqV05TNvO3vXDs0YC/aeAs3CnRKEU0craOrKW7sEw6BlCzxB6htAzhJ4h9AyhTYmeoapnqBW1RlvnsrRvSiBew9xxuP/ypg6IO66kcG1K5V8q60p8mR8+yr0f6aY8cwutedHPTh7QCVc+Nk7qXMFBgs6FYz0KJJvyGoS5kZPJo4je/WE08s4HzydVnmkKHUMzGc1kNJPRTEYzGc1kNJPRTH7iZvIBZmerA7Iasf9C7FOnOZv066o5hDxliSc6a9TFTW09IcPesLMlJlsmstl7kkhmihNkFrYRobNvkMh7L+n2hpBn2X4Q2hzYVfu8YzE3GdrLhdWtQx7JZkeF8fQVRofO32TGlUKpcECXPfhYDoTaiEc0NLVh4e1wzMJbEBEGMrz8RYBFnpAvjhnIsHdoQkV/u1IijTLZ7Q7XxeMOMn0NknWCSQNH2OEryJJZYGQT0Wp5uYPWAVaEctuLjfn8Lg1UhwvsdPoVD9jMD34k3cWWYZHl3sMvADpY24S4DGlX3bH8BRH3L2RGl7nGrnRiWvQpxITz25W/b1BtvWzxhPF3yBdHrqNi5WYTChsN21wlm1DhPuhfLaNL2HeP0FtLL/VFpe8aCXqobKt9tmlqr5k2MUR9i/oW5erTlquob5EvUN8+U307YXdScftNHqE2HC7IJ70gu5zaj2Rh7E68NUR/LniysrZsE5aAOiTi6sjT9k8qZpXl6jwLBEAE9oqKZWJpynXKTGivqtDuCwea/wWBAhbGrmXx1FWsW7Xe15B6DKWbgmE2TK+HEG5OxrHfzmearGbcIgyPGzT3pahYXkwSrBFhQ0isn4zXsnH/8ebt9w6YY5fHLPm3ArkHhu3Am6NyXYtLO8ZKdwc6VCB0LB8nurJXLFmb2bBKMHdReQo8cjVV0znG9y4gYQwdGqk40Sb//EYTn5JFVpUre4qqCl77y0QPRLPpo5fRcstPZllfG0CBE44u6T1lom+w5YoIvQ4WfuYJfHTN6xaTe+7IUCPKVslyzyMTd/DC+d9tOGYMfBp3cNwPrqaBG3bLQixfdwfnFgbSZxmLIJKwtHT8NUPrFdOaUt5TNoWzotuYadhmYC1Fg31ffO4ggUl1si2hIq65dTH0b71O9a72G7Rv7YCui5dsEfd1XRTkPHCXhF/7C0eBVo2MTiujScUWKvpy2b9BYXjl2xq0tupfj96s7nn6bTsa40S7gks3j8rLqt4d1y7VY96XsXMHZ433DKPd1xbBNJeN/pjmgmkumOaCaS6Y5vKiDJw901zW81MKzd6YV3KcvJWlBVI+KA2MR+H8baKs9QYxZPmnz/KtUmuNm1ar4WB7FQ1NNDTR0ERDEw1NNDS/Qq37XPOp9xUZeLErrhYMkES+eKoBknix61fNSXixK17sihe74sWuNSrhxa6oLvBiV+QRvNi1/6YcL3bFi11f0hL+4he7Nvnp8GK3VQu82A0vdkN5+mzkKfpxkS/wYrcaxnix2/4Oza/5YrcmyxAvdsGLXfBil8OWCRZ2x8LuWNgdC7ujrY6F3bGwOy4CLOyOfPH/d2RgYXcsNIuFZlE8PQm1hf73F80XWGj2GRSaxcLuqG9R3z4ruYr6FvkC9e0z1bdY2P3rWZBY2P2Y0/ZPsLA7FnbHwu5Y2B0Lu2NhdyzsjoXd0SJ+4hYxFnb/er42FnY/uLB7F4O3FkrdWr/voKIktQKwneHr3RVsNyrMbitFu4wlX0OmnGprtEHZYKNWvgtnqAMsnm+OVDxcLIqpxzKyBTjB+HTH2C7yciB9Np/6Lr9Etu6EBnXnZNn13GnqIY2NyfTw7EwzEY3lwykb65Qpk8xOQ5nSxY1LE8gVt/Urr+duTV1k/Few/95UX1+GMaSeH6qNVp/EPxhQbrMxY189cS2bjl4Q25dcfPiF/AozMpH+N8tNLBX/y9nEp+Tk5LdcGzIGwgUxMRAvBMiIXmT8O9txJnMvtgOW8eAWZiN6ckJL85ReVOFZsjjc6ZD+twAwGunR6PJvjiO4mLgzo/IblJFwA7rMV6GvT89PzzdnI8j7DISdwWUGIZ8UqSnExMwUOexj0G4KFz8WdHcTthO/l8pVY73nJnYTqqTAa5IpOVUsTZnhIUuS2Sn1dp2P97U7Dx6C0H6/7Wf9QclMcTBMzXxcu9Qm9YHLRQvLXuSKTcm7n67WZzMvzUY6pCcnfxS7WvIBVMq1JYM+ORmSTw7EOzCfiFTFfxdRysUnutznG3gwZ1nCuM/d9xrLc+71coloOqDDJe/SmwGNpTa2xXxuDdGPKlks7OM/c1COGQs57xTk9ZxGXNvfUaFZW2bzbTmZV8Tn67vKuDGQJTnc95rJnNxzHduyu1MwxLpGyETJ9HTb1ErOF5btizBuSgf01i4Muprc4sbtDdyKsKj79xdhCJmp9KykSp191nZzeFMRAPaTLRb/A/3rLsc= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Goal Tag GET

- - - - - -**Required Permissions**: `Goal Get` or `Goal Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a goal tag's data. - -
Schema
    goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • metric object
    tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • ]
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/goal-tags-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/goal-tags-list.api.mdx deleted file mode 100644 index 0fd95f29..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/goal-tags-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: goal-tags-list -title: "Goal Tags LIST" -description: "**Required Permissions**: `Goal List` or `Goal Admin`" -sidebar_label: "Goal Tags LIST" -hide_title: true -hide_table_of_contents: true -api: eJztHV1z4zbur3D40mvOTbK7vemd39Kbttfrx+402XuJc1pagi1uJFJLUkncjP/7DUnJlmxZkr9ukyw6s1NHIkEQAgEQBMBHGoEOFc8Ml4IO6cnJH/Ap5woi8g5UyrXmUuiTkyH58JNkCfmVa/OBSFX8eRGlXHygA5oxxVIwoDQdXj9SwVKgQ6qlMnRAuYX8KQc1o4OV8a5iIHL8EUJDbmFGjCS2DzExEAU6T4wm49kpHVAdxpAyOnykZpY52EZxMaUDCg8szRL7yI06nw9q4wdMh6s4rAEbS5kAE1VoRuVQhZWxKXTC4cLAFFQVzqsqEG4g1btA+dt8fjOgCnQmhQZtG78+P7f/q9Pzgvz78u3v5K0naSiFYVxwMSVMEKYUmxE5ISxJyNR+PsOm2hLXtgNhLDiWZQkPmQV39lFbmI/rCPovZj+7khkowz1Gfnbr85gPPPWaZphywdM8tXQaUCMNS5oBWHwDi2/ltZuQpebKuJvQi5pBGzZt56tMz8JYJnLKQ5YMr1Suje0XKmAGooCZpu4TqVL7hkbMwDeGW9Zc9hnPuvFlKoz5HUTtfDphiYb5gLI7ZphqgiryJGHjBU+XTYMJTyDIs0SyKMhV0k6Ds1DJ7L1Kzl6dnz+8Oj8/e3Waien+ZAhyDSpo/DQrzBFBxpRJCz7djOlvTN2C4R45SBlvnNkCL99ibvmAGwfgvfZ80QvJ+YDmWVQhQJ3ag54EKWEgXzxxvmgg2/LbtSK91s+KtD3EmZOIm3jSvtxdInpt1SoScxXGTLuPVtNAbZ0uvNaZSEWMYuGt1UuxvCcpEzNSQtSEKSApi4BIQewbOSEyV6SimTSK3xe+zHYWvz0I0LqEkS+eNF8cUPxu9x3bTU8achXmCVN/sdsi+++KTb92xiWw9LhCvj7219SPubGTfbm7ZoAHA0oscNpg7GylSmqMgUL9BS9eFOrIF0cW6rbxHuK2nSctrshJT5mT5r2U31JjXgFLvZquQLEPHWh4yEBxi3srSy2b7ahXa97CPirTgDZBZdi5w0axlS3Yhk+iDTMdA6hciOJbRHAHiczsOHtJY22Y2heCzHYHUJmefTEf0EmeJIEUe/ltShh3THEm2gA1fIzzAU3Zg//9Zj6gCdMm0AAi4CIIZQR7kUuoEqsmn2x16Cp/VMhkUcpAhSAMm4JuwiRjxtqDdEhHo+jx9Xw0Olv5UWOrN9+evXlz9uZNE7rLkQI5CYxikwkPOxbL+bllC6gJ23UqjfmU+0VSQA226IIG6ctWF7sgicbpl8UjPY3RqhBdI3VvJ+lVzDVZ6vavNKl2tdgIbgLf/3j+3XKe22EOhEe69Nd6U/yYfHHws5fqWN2uDRTzz2cJb0P/anfBzZVtXl13m2ZYM+IzxVOmZkEKRtXsmC2X6mYHYGXA7857LeornoINsfheytutVzZLZS6MXdz2w5MxTKQCwshYSn+QwzQZAwh3dOOMrbqIagDrz/R5CoGRAQtjDndQ7mdgMrFkauovLBdd00xqbvid064wZcXPXNwKeS/ozdYeXs9FgTaqHevHuZNqOmRJc0jDCh9AyHWdwiJPx/WW9vvdsSSHQMtchRAUzDFrR8VFVhQtrQgw0IH7kdd4beafUzRv9Ix/ngCSRPpzy+G/gEV15fGylGJFdP7mBN8Vm7qn8l7s5ZjzYrTVNYd+u2esodcY561lGP98vxO0Ds4p9fNSVvjxe56jtbgSiwXgnYlrz+majdApVF9bLcHyiIMIGzVr1RvzOKJeIYzo8JGJaDgaXd/M57QCwqo6XtOxLQwfzzJpYtC8wQ/k1VzEw2ZLwg7pXgWZ5HVv1LIFt8NZdnOCMojAMJ40N7V4NOi5+YKDbW8IjV2FwZod0ehH2vt4uBacsjOvVj3JS876YfHUMmVlpGNuALnUW5mIb3NF+NtLG6WDbrOXLq3xHBf5Yp9z3G4Dfrvv2OugrkmgXiyF6de1+VRe0NoAGzm9Ipd7tbkDpTcd162dQ1Qwa0TetWg47dlS/4RSTHjHXqYPObY+0PwDIvJ9boynduUwbTN71w/PGgn0nwLO3J0ShVJES2vryFq6B8OgZwg9Q+gZQs8QeobQM4Q2JXqGqp6hVtQabZ3L0r4pgXgNc8fh/vObOiDuuJLCtSmVf6msK/Flfvgo936km/LMLbTmRT87eUAnXPnYOKlzBXsJOheOdRBIETMsCHMjJ5ODiN7dYTTyzjvPJ1WeaQodQzMZzWQ0k9FMRjMZzWQ0k9FMfuJm8h5mZ6sDshqx/0LsU6c5m/TrsjmEPGWJJzpr1MVNbT0hw96wswUmGyay3nuSSGaKE2QWthGhs2+QyHsv6XaGkGfZbhDaHNhV+7xjMTcZ2ouF1a1DDmSzo8J4+gqjQ+evM+NSoVQ4oMsePJQDoTbiEQ1NbVh4Oxyz8BZEhIEML38RYJEn5ItjBjLsHJpQ0d+ulEijTHa7w1XxuIVMX4FknWDSwBF2+AqyZBYY2US0Wl7uoHWAJaHc9mJtPr9LA9XhAjudfsUD1vODD6S72CIsstx7+AVAByubEJchTV2Vx+IXRNy/kBld5Bq7eo1p0acQE85vV/6+QbX1ssUTxt8hXxy5joqVm00orDVsc5WsQ4X7oH+1jC5h3z1Cby290BeVvisk6KGyrfbZpKm9ZlrHEPUt6luUq09brqK+Rb5AfftM9e2E3UnF7Tc5QG04XJBPekF2ObUPZGFsT7wVRH8seLKytmwTloDaJ+LqyNP2TypmleXqPAsEQAQRrSSWplynzISxtaXcFw40/xMCBSyMXcviqatYt2y9qyF1CKWbgmE2TK+HEG5OxrHfzmeaLGfcIgyPGzT3uaioistjghUirAmJ1ZPxWjbuP16/+dYBc+xyyJJ/S5A7YNgOvDkq17W4tGMsdXegQwVCx/Iw0ZW9YsnazIZlgrmLylPgkaupms4xvnUBCWPo0EjFiTb551ea+JQssqxc2VNUVfDaXSZ6ILp+Lc1Bsqjd8pNZ1tcGUOCEo0t6T5noG2y5JEKvg4UfeQLvXfO6xeSeOzLUiLJRstzzyMQdvHD+dxuOGQOfxh0c952raeCG3bAQy9fdwbmFgfRRxiKIJCwsHX+30WrFtKaU95RN4azoNmYaNhlYC9Fg3xefO0hgUp1sS6iIa25dDP1br1K9q/0a7Vs7oOviJVvEfV0XBTn33CXh1/7MUaBVI6PTymhSsYWKvlz0b1AYXvm2Bq0t+9ejN6t7nn7bjsY40a7g0vWj8rKqd8e1S/WY90Xs3N5Z4z3DaHe1RTDNZa0/prlgmgumuWCaC6a5vCgDZ8c0l9X8lEKzN+aVHCdvZWGBlA9KA+MgnL9JlLXeIIYs//RZvlVqrXDTcjXsba+ioYmGJhqaaGiioYmG5heodZ9rPvWuIgMvdsXVggGSyBdPNUASL3b9ojkJL3bFi13xYle82LVGJbzYFdUFXuyKPIIXu/bflOPFrnix60tawp/9YtcmPx1e7LZsgRe74cVuKE+fjTxFPy7yBV7sVsMYL3bb3aH5JV/s1mQZ4sUueLELXuyy3zLBwu5Y2B0Lu2Nhd7TVsbA7FnbHRYCF3ZEv/v+ODCzsjoVmsdAsiqcnobbQ//6i+QILzT6DQrNY2B31LerbZyVXUd8iX6C+fab6Fgu7fzkLEgu7H3Pa/gkWdsfC7ljYHQu7Y2F3LOyOhd2xsDtaxE/cIsbC7l/O18bC7nsXdu9i8NZCqRvr9+1VlKRWALYzfL27gu1ahdlNpWgXseQryJRTbY02KBus1cp34Qx1gMXz9ZGKh+4/N/dYRrYCJxif7xjbVV6OpO3OEtSdE2DXj049D2lsTKaHZ2eaiWgsH07ZWKdMmWR2GsqUzm9cbkCuuC1aef3oFtJFxn8B++dN9fVlGEPqmaDaaPkd/IMB5TYFM/YlE1dS6OgFsX3JxbufyS8wIxPpf7PcxFLxP50hfEpOTn7LtSFjIFwQEwPxK5+M6EXGv7EdZzL3sjpgGQ9uYTaiJye0tEnpRRWeJYvDnQ7pfwsAo5EejS7/6tiAi4k7KCoJX4a/DegiSYW+Oj0/PV+fjSBvMxB2BpcZhHxS5KMQEzNTJK6PQbspXHxf0N1N2E78XipXgvWem9hNqJL3rkmm5FSxNGWGhyxJZqfUG3M+yNduN3gIQvtNtp/1OyUzxcEwNfPB7FKb1EcrFy0sT5ErNtXk158vr1bn81hai3RIT07+KDaz5B2olGtLCH1yMiQfHJBfuTYfiFTFnxdRysUHutjfG3gwZ1nCuM/Z95rKM+w1XTLszYDGUhv78PHR2pzvVTKf28efclCeIyOurSaMCrXZgrPNwPdii9zCzJbM1VIZR30FOk+MJmNHx0Ykby03U9uDLkLCbbpPAwbLpgHTYc/mmd1l9GvqRVm17U2h2ZxJcH3j9hdugVkK+U4XYQhZFfdKutXZR203mDcVGfLTD1d0Pv8fu9ew1w== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Goal Tags LIST

- - - - - -**Required Permissions**: `Goal List` or `Goal Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all goal tags. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    goal_tags object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • metric object
    tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • ]
  • ]
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/goals-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/goals-list.api.mdx deleted file mode 100644 index 82c45e8a..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/goals-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: goals-list -title: "Goals LIST" -description: "**Required Permissions**: `Goal List` or `Goal Admin`" -sidebar_label: "Goals LIST" -hide_title: true -hide_table_of_contents: true -api: eJztHV1z4zbur3D40mvOTbKbdnrnt+xN2+v1Y3c22XuJc1pagi1uJFIlqSSux//9hqRsS7YsyV/dJIvO7NSRSBAEQQACAXBKI9Ch4pnhUtA+PTl5D3/kXEFE3oFKudZcCn1y0icff5IsIb9ybT4SqYo/L6OUi4+0RzOmWAoGlKb9mykVLAXap1oqQ3uUW8h/5KAmtLcy3nUMRA4/QWjIHUyIkcT2ISYGokDnidFkODmlParDGFJG+1NqJpmDbRQXY9qj8MjSLLGP3KizWa8yfsB0uIrDGrChlAkwUYZmVA5lWBkbQyscLgyMQZXhvCoD4QZSvQuU72az2x5VoDMpNGjb+PX5uf1flZ6X5D9Xb38nbz1JQykM44KLMWGCMKXYhMgRYUlCxpIl2hLWtgFhLCiWZQkPmQV19klbeNN15Pxq2SVXMgNluMfGz2x9DrOep1zd7FIueJqnlkY9aqRhST0Ah2vplZuIpeLKmJtQi+rB+jVpYqgsV2HMNNjWFTo3dbp0tCUjqYhRLLyz1I/lA0mZmJA5RE2YApKyCIgUxL6RIyJzRUproO2woQJmIAqYqRt1JFVq39CIGfjG8BTKfYaTduIwFcb8HqLmzTBiiYZZj7J7ZpiqgyryJGHDxcaZNw1GPIEgzxLJoiBXSTPpzkIlsw8qOXt1fv746vz87NVpJsb7kyHINaiglg9WuDCCjCmTFhtiM6a/MXUHhnvkIGW8dmYLvHyLmWVzbhyAD9ozYSckZz2aZ9F2BKhZkjkM5IsnzheNa9eI9Dq5t1pHw8Z7CFor9zYysH1J+zTkKswTpv5m7YevqX8eGDZu7Ggb7C7oq53r5LyehLFM5JiHLOlfq1wblL0vfI/tLHur1O51JAjK3mfCFweUvS12a1UW2n/XbPx1BaPi4dqzynNg6V8ttO2YGzvZl7sLa3g0oMQCpw27bSszvsIYKNRf8OZFgxr54shC3TbeQ9w286TFFTnpKXPSrJPyW2rMa2Dp13QFin3oQMNjBopb3BtZatlsR71a8Ud2UZkGtAlKw84cNoqtuL82LIk2zLQMoHIhirWI4B4Smdlx9pLG2jC1LwSZ7Q6gND37YtajozxJAin2+nCYw7hnijPRBKhmMc57NGWP/vfFrEcTpk2gAUTARRDKCPYil1BzrOo8v+Why/xRIpNFKQMVgjBsDLoOk4wZaw/SPh0Mounr2WBwtvKjwlYX355dXJxdXNShuxwpkKPAKDYa8bBls5yfW7aAirBdp9KQj7nfJAXUYIsuaJC+bHWxC5JonH5ZPNLRGC0L0TVSdz6guo65Jkvd/pUm5a4WG8FN4Psf72xtPs/tMAfCIz0/K/Om+DH54uDOv/JY7a4NFPPPZwtvQ/9yd8HNtW1e3nebZlgx4jPFU6YmQQpGVeyYLbfqZgdgacDvzztt6muegg3ieCPl3dY7m6UyF8ZubrvwZAgjqYAwMpTSH6IzTYYAwh2bO2OrKqJqwPqzI55CYGTAwpjDPcy/Z2A0smSq6y8sF93QTGpu+L3TrjBmxc9c3An5IOjt1qdrnosCbVQz1tOZk2o6ZEl94MQKH0DIdZXCIk+H1ZZ2/e5ZkkOgZa5CCArmmDSj4uI3ipZWBBhowf3Ie7wy888pmjd6xvc6Qd35BDORPmak/29gUVV5vCylWBKdvznBNz8GkQ9iL8ecF6ONrjn02z1jDb3GOG8twxziBK2Fc+b6eSkr/Pgdz9EaXInFBvDOxLXndM1GaBWqr62WYHnEQYS1mrXsjZkOqFcIA9qfMhH1B4Ob29mMlkBYVccrOraB4eNJJk0Mmtf4gbyai3hYb0nYId2rIJO86o1atuB2OMtuTlAGERjGk/qmFo8aPTdbcLDtDaGxuzBYsyNq/Uh7h+ZUAgN35tWyJ3nJWT8snlqmLI10zA9ALvVWJuLbXBH+9spGSKLb7KVLazzHRb7Y5xy33YDfbh07HdTVCdTLpTCthvaUXtDKABs5vSSXO7W5B6U3HdetnUOUMKtF3rWoOe3ZUv+EUox4y7dMF3JsfaD5HiLyJjfGU7t0mLaZvauHZ7UE+m8BZ+ZOiUIpoqW1dWQt3YFh0DOEniH0DKFnCD1D6BlCmxI9Q2XPUCNqtbbO1dy+mQPxGuaew8PnN3VA3HMlhWszV/5zZV2KL/PDR7n3I93Oz9xCa150s5N7dMSVj42TOlewl6Bz4VgHgRQxw4IwN3I0Oojo3R1GLe+883xS5pm60DE0k9FMRjMZzWQ0k9FMRjMZzeQnbibvYXY2OiDLEfsvxD51mrNOvy6bQ8hTlniis1pdXNfWEzLsDDtbYLJhIuu9R4lkpjhBZmETEVr7Bol88JJuZwh5lu0GocmBXbbPWzZznaG92FjtOuRANjsqjKevMFp0/jozLhVKiQPa7MFDORAqIx7R0NSGhXf9IQvvQEQYyPDyNwFWGUG+OGYgw86hCSX9vVp3pPJqXTxuIdNXIFknmDRwhC98BVkyCYysI1olL7fXOMCSUO7zYm0+v0sD5eECO51uxQPW84MPpLvYIixy/u3hNwDtrXyEuAxp6upIFr8g4v6FzOgi19hVhUyLPoWYcH67+e9bVFsvWzxh/B3yxZHrqFi5WYfCWsMmV8k6VHgIulfLaBP27SN01tILfVHqu0KCDirbap9NmtprpnUMUd+ivkW5+rTlKupb5AvUt89U347YvVTcrskBasPhhnzSG7LNqX0gC2N74q0g+mPBk6W9ZZuwBNQ+EVdHnrZ/UjKrLFfnWSAAIohoKbE05TplJoytLeVWOND8TwgUsDB2LYunrmLdsvWuhtQhlG4KhtkwvQ5CuD4Zx66dzzRZzrhBGB43aO5zUVEV19MEK0RYExKrJ+OVbNx/vr741gFz7HLIkn9LkDtg2Ay8PirXtbiyYyx1d6BDBULH8jDRlZ1iyZrMhmWCuYvKU+CRq6ia1jG+dQEJQ2jRSMWJNvnXV5r4lCyyrFzZUVSV8NpdJnogunr5zUGyqN32k1nW1QZQ4ISjS3pPmegabLkkQqeDhR95Ah9c86rF5J47MlSIslGyPPDIxC28cP4PG44ZAx/HLRz3vatp4IbdsBHnr9uDcwsD6ZOMRRBJWFg6/gal1YppdSnvKRvDWdFtyDRsMrAWosG+L5Y7SGBUnmxDqIhrbl0M3VuvUr2t/RrtGzug6+IlW8RdXRcFOff8SsLV/sxRoGUjo9XKqFOxhYq+WvSvURhe+TYGrS37V6M3y9883T47auNE24JL14/K51W9t7r3YxE7t3fWeMcw2l1tEUxzWeuPaS6Y5oJpLpjmgmkuL8rA2THNZTU/pdDstXklx8lbWVgglfvD5g/35fzGGxyR5Z8vyzdKrRVuWu6Gve1VNDTR0ERDEw1NNDTR0PwCte5zzafeVWTgxa64WzBAEvniqQZI4sWuXzQn4cWueLErXuyKF7tWqIQXu6K6wItdkUfwYtfuH+V4sSte7PqStvBnv9i1zk+HF7stW+DFbnixG8rTZyNP0Y+LfIEXu1UwxovddndofskXu9VZhnixC17sghe77LdNsLA7FnbHwu5Y2B1tdSzsjoXdcRNgYXfki7/ekYGF3bHQLBaaRfH0JNQW+t9fNF9godlnUGgWC7ujvkV9+6zkKupb5AvUt89U32Jh9y9nQ2Jh92NO2z/Bwu5Y2B0Lu2NhdyzsjoXdsbA7FnZHi/iJW8RY2P3LWW0s7L53Yfc2Bm8slLqxft9eRUkqBWBbw9fbK9iuVZjdVIp2EUu+gox94v5z6MQyskUxwfgUxNhuPE9kG3av7p08uZk6bdmnsTGZ7p+daSaioXw8ZUOdMmWSyWkoUzq7daH6ueK2huTN1PH1ZcZ/Afvnbfn1VRhD6tek3GhJFv+gR7nNiIx9BcOVjDZ6SWxfcvnuZ/ILTMhI+t8sN7FU/E9nl56Sk5Pfcm3IEAgXxMRA/EYkA3qZ8W9sx4nMvegMWMaDO5gM6MkJnZuI9LIMz5LF4U779H8FgMFADwZXf3erwsXIndvMKT6PRuvRRc4IfXV6fnq+PhtB3mYg7AyuMgj5qEgPISZmpsgjH4J2U7h8U9DdTdhO/EEqVxH1gZvYTaiUhq5JpuRYsTRlhocsSSan1NtWPubWWv88BKH9N6+f9TslM8XBMDXxseVSm9QHDxctLDNp8uvPV9erc5nODTfapycn74vvSvIOVMq1JYI+OemTjxYA+ZVr85FIVfx5GaVcfKSLT20Dj+YsSxj36fNeaXhGvSmkwW2PxlIb+2A6tabfB5XMZvbxHzkoz4kR11YhRYX2asDXJsJ76UHuYGIr12qpjKO6Ap0nRpOho18tgneWi6ntQReR2TbrpgaDZdOA6bBj88wa+92aeolSbntbKBinmW9unZnvNpalkO90GYaQlXEvZT2dfdL2O++2JDd++uGazmb/B8dcqFI= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Goals LIST

- - - - - -**Required Permissions**: `Goal List` or `Goal Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all goals. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    goals object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • metric object
    tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • ]
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/metric-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/metric-get.api.mdx deleted file mode 100644 index 0defcdde..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/metric-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: metric-get -title: "Metric GET" -description: "**Required Permissions**: `Metric Get` or `Metric Admin`" -sidebar_label: "Metric GET" -hide_title: true -hide_table_of_contents: true -api: eJztXW1z2zYS/isYfGnjUy0nzkzv9E25aXO5TptM7NyXyMdA5EpETAIsANpWNfrvNwBIihQpknq72A46k6lCAgtgsW9cLJ4scQDSFzRRlDM8wmdnH+HPlAoI0AcQMZWScibPzkboy++gBPXRW1BfEBfF38dBTNkXPMAJESQGBULi0eclZiQGPMKxafUuwANM9QAJUSEeYJGNgkdKpDDA0g8hJni0xGqR6H6UKZiDwKvBxgyvQ0A0QHyGVAjIkkcqJAoteIruqQyR4mgOCgVEETQTPD7Hqxs9pEw4kyD1KK8uLvT/qqTH6N9X7/9A76dfwVfI50wRyiibI5KN84M0RM/xAOu3wJQmQpIkoj7RRIZfpaa0rK+HG6KaTYInIBS187B0u9vRoJk3c04ir/HlAMMDiZMI8Ojni9Ug24+imVSCsnm5Fb6mMWjeveH8tsb31o4hIBLzlCmzLZrMFGZcACJoyvmtZmFIJJoCMBSTADR1S66NrFmbpuYp7hE/pHAHseb5aoBhNtNsaurP0hiPPuOES6roHeABZjAn2c+U3TJ+z/DNaoCJ8EN6B2XmTTmPgLDyNGYkkrAa4BkXMVGeVKJ91suV1BOUPomgfVtervQug09llcMsjafVlnr/7kiUgid5KnzwMuFYtE8FrwoxWngzGinomLvu4AsgCgKPNHLXcgGPcEAU/KQ3p9xnuvBSCaJTIPXK0yQojcPSKCJT/c7ag37j5jSq426htaE1++tctyYlqfBDImEnLRojPS004wIpQXyrNfwexYQtUE5RIiLA6BDiDOk3fIZ4KlDJCMnDt7GbObspD7kjiogmqtXNKppqcQUvTSJOAi8VUTvrhr7gyScRDV9eXDy8vLgYvjxP2PzE0hxTRmNta16aXU6IUHHmEbbP9HcibkFROzmICW1cWTEv22KlzSVVhsAnaYWw1yRrataDAQ1bslYzJxePWi5a96510nV277SPisxlqSURgix0xKcglt0ysz2IKWw19qnw04iIH99yEr3AWeSjyLy1o26wv6Gvdm6y83Lhhzzic+qTaHQtUqmc7X3mOra37T00xHFy8ajl4oi2V1uuFnNatYX6zzWZv6jMKHtYe1Z5DiT+fxttPebWTvrl/sYaHhQIVsyp+yOgO4yvCIYz6s9YeV1A7eTixEZdNz7A3LbLpITGPXeS9GgkadXL+a095jWQ+AXeoKIfGtLwkICgeu6tIrVutqdf3cjZdbtMBVJ5pWFXZjaCbKS/tmyJVER1DCBSxrK9COAOIp7ocQ6yxlIRcSgFnuxPoLQ8/ULnmtMo8jg76MMhp3FHBCWsjVDDZlwMcEwe7O/L1QBHRCpPAjCPMs/nARzELibyWclmmSiGLstHiU16SgkIH5gic5BNM0mI0vEgHuHJJFi+Wk0mw40fFbG6fD28vBxeXjZNdz2Sx2eeEmQ2qxzZNCnLhU7ZS6gY2zqXpnROrZJkVL0duriA9Hm7i30m6YLT70tGegajZSNaY/UOx7xUorVv14fhpa56Nowqz/Y/3dlavs5dD6hpIPOzMhuKn1IuvvH5pjPzT0eFd+F/uTuj6lo3L+tdr4P3RNCYiIWXl56svzlsRc8LvNmmk+wrHe2QNKDA/Eb1LUdjywm2tQgTPFoSFowmk883qxUukdBVFrRS3tEikuEi4SoESRviQFthEVC/2UboIc0rL+G0Go2uW1A9nBYI8xHjBaAIjZqb6nk0lFisChnTvcFXWk+8WglLYxx58NFcpTBg7/RD+UtyLTC/FE+10JRGOqUDoFzuZPzfpwLR91e6QsKFzc/fnro8rpOL/fO43bHVbvvYK1HXZFDHa2NaPdorvcCVAbZKesku92pzB0JuS9fV8hClmTVO3rRoyPbs6H98zma0oxqjDzt2Tmh+hAC9SZWy3C4l0/omzxoZ9J+MzspkiXzOgnW0dWIv3UNg2iLDtoiwea1X+fosEdMqEXBH4f7bLxXYHRWcmTb5l2teQVzKL9vhg9TGkTd5zO3rmud+ejLAMypsbpzLVMBB34UmHXsUSrqc3fNTxWezo3yp7k+jUXY+WDkpy0xT6viJqckBYtdqgMoZ+2cin6bqvbSCojZ+3Rx8GpPIbghprKNvamsZ6femnRQz2bKQeu9ZxInKviCJ38aEzr5exO/tl+XeFNIk2Y9CmwMr62dHPVGTohWHnPyedZyOH0ln3Un5o4/Vs13aflJeE8b3Wno2zsW9rpLkYwUQlRH3z3t01hpLRfzb0ZT4t8ACl8h4/krgqoydXJwykbF3aqLkvzfrjiuv6uZxB5u+QUl/q3MFBwT924YWkEQLT/EmplXqcgatA6wZZeqca+v5gysoD+fp5fQrHqzXBx3Jd5HiWCT/9rAKgAcbHyGmQsrc2s5/QUDtC57gotbIXIuOsz6ZmTB3bvPfN85tPW/z5PLvTi5OXEet7WbTFGoN21Ildapw7/Wvlu0y9t0j9PbShb8o9d1gQQ+Xrb3PNk9tPVN9hs7fOn/r7OrjtqvO3zq5cP72ifrbGbnjguo9OcLdMKeQj1ohu5LaR4owdmfexkR/zWSypFu6CYlAHHLieuJl2yelsEpLdZp4DCAADT1XFJbGVMZE+RqCTpod9iT9CzwBxA9Ny+ypubG2br1vIHUMpxuDIvqYvocRbi7G0XtnK03WK24xhqc9NP9WXMwBB70NJtSMxObJeKUa9x+vLl8bYkZcjnnlb01yjxm2E2+uyjEtrvQYa9/tSV8AkyE/TnVFrxKstrBhXWBuEPUE2MlVXE3nGK9NQcIUOjxSdqKN/vmDRLYkC61vrvY0VaV57W8TLRFJ5ke/RmPUjydJ3xhAgDGOpug9JqwvUOKaCb0OFn6lEXwyzasRk3lu2FBhylbLck8DFXbIwsXf9U2FEOg87JC4n82dBjPsFkXMX3fXEGYB0lceMi/gUEQ6FkJ088ZUU8l7TOYwzLpNiYRtAVZhGvT7bLu9CGblxbaUipjmOsXQv/Um17va13jf2sGlLp5zRNw3dZGx88CvJLfb33K3N4KMziijycVmLvqq6N/gMKzzbS1aW/fHq+aGPQvrmzE7uoA+6kflOarHTrhfRe3cwVXjHbWqbWWuh0GaWDrZ8kvPC4ZU4Mzyh921gu3LbQWUdHWDT9fEtKZYNqRpXTLYqT51ud8khg9GQN27KjDi9prN6F9Agv2/sB//pfa62cjKgg41Bx3Wz+FuPXGrUBOcteofiIB5Wr+5f0rV4WA6bXHnyU4uHud5ssPB/K4lyeFgOhxMh4PpcDDnDQeZDgfTuQuHg+lkZI/En8PBdDiY9bGdmX86KuxwMB0OZksc6XAwa0VBDgfT2VOXx3Vy8W3gIxwOZiUP4XAwHQ6mw8Hs1pNHijPocDAdDuZjlk+Hg+lwMB0O5ncVqzsczEbmOhzM70wJHA6mkwuHg+lwMB0ul3NbT8U8ufy7kwuHy/VEcbkcDqbzt87fPim76vytkwvnb5+ov3U4mN+PQjoczFMu2z5xOJgOB9PhYDocTIeD6XAwHQ6mw8F0EfEjj4gdDub3s9sOB/NgHMwuAW8FcrToj8eNJ8pikqTCD4mEna5mjZGeFppxgZQg/i1lcxTyexQTtkA5RYmIABSTABBnSL/JrvFWbrY5d/HMDYjLdDu5OG2me7d9PAz4tIet3oLU21ZGlTfY39B3lqEmcuGHPOJz6pNodC1S6UL1565jrhjVycWJbe9OEPAGFn2z9DR7WHtWed73ikoFaN4Brzvxf4TA6wehSVb+ZYGdZ5SRa/unC7b9GwfFJWDznxk75AEe4TkoCxQTalHKpjRc2h/vAg3XJ0HcGU38vDQJzhEOlUrkaDiUhAVT/nBOpjImQkWLc5/HeHVjblengqqF6aS3bZzQ30D/9ab8+soPIbY6VW60Zoh9MMBUg9iEFnR+40sXj5Hui8Yf3qHfYGE+a/VvkqqQC/qX+VI9R2dnv6dSoSkgypAKAVk5QxM8TuhPuuOCpzbb5ZGEerewmOCzM5x/heNxmZ5mi5k7HuH/ZgQmEzmZXP3N7AdlM1Nql/M/v0A0wMU1f/zy/OL8or4aht4nwPQKrhLw6Sz71kYqJCqD/pqCNEsYv8n4bhasF37Phfmcv6cqNAsqIYdJlAg+FySOidJhZLQ4xzYdbq9J6gMb6gOT9pjSrvqD4ImgoIhY2OvAXKrY3vfMWljRQm9/ud5cyzLPteMRPjv7mB0Fog8gYio1E+TZ2Qh9yQmA+oK4KP4+DmLKvuAifFHwoIZJRKgFPbNm0Qru50KXBniUiy6+GeCQS6VfL5c6ff9JRKuVfvxnCsLIYpYdMyb48xIHVOrfQWa7W5bzY76aF8iinOnsiN4SO7rdrAVP0T2VIVIczUEhfZyMZoLH59tWlYs90zKfXX3FeIBvtVbgYmWrG3OcYrRBz9u+Hvs+JKrUsZSpGX6V+jztpqT5esNWq/8B+yATIQ== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Metric GET

- - - - - -**Required Permissions**: `Metric Get` or `Metric Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a metric's data. - -
Schema
    metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/metric-tag-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/metric-tag-get.api.mdx deleted file mode 100644 index ccf83667..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/metric-tag-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: metric-tag-get -title: "Metric Tag GET" -description: "**Required Permissions**: `Metric Get` or `Metric Admin`" -sidebar_label: "Metric Tag GET" -hide_title: true -hide_table_of_contents: true -api: eJylVcFy3DYM/RUOLk23yq7bo27qTCdNM649tXPyumushJUYSyRDQrZVjf69A1LryHbcdNq9rEgBD3gAHjRCRaH02rG2BnJYrf6gz732VKlz8p0OQVsTVqtc3ZwSe12qd8Q3yvrHc1F12txABg49dsTkA+RXIxjsCHLootUl1u8ryEBLDIfcQAZ+DgQ5+54yCGVDHUI+Ag9OXLVhqsnDlD1L8rIhpStlD4obUnMel1grbpDVYHt1r0Oj2KqaWFXIqA7edmuYriVscNYEChLpp5MT+XsKX6jfLs5+V2f7T1SyKq1h1EabWqFKbBRj/V2IwGvIQCzIsAChc60uUYA2n4KgjS952QgsFfPWkWedcknYO8b627a6+nqdnjoH9trUkAE9YOdauWptyi7/lbBKPqUnZKp2yF9zPVjfyRuokOkt646WPvth1wfyu9fy6V21wDZ92+Je8kgd/3exjhhPY72C9RhbiqE5cj49jiBM6ZdJrRtbQQ41xeLKROaw+dKCsBkXkztBBoH83XG2e99CDg2zC/lmE9BUe/uwxn3o0HM7rEvbxVkLVPZe8xCdPgbyhdMfSI7Xy9cXMiGpsUujx4Jiupjl06TOPRdFocRXFefv1Qca1MGmZ+y5sV7/Fbu+VqvVaR9Y7UlpE9WTaq62UDj9VhwH2/tUaHR6d0vDFlYryI56LpZ4MKtWXvw5A2y3Ybu9+CF2QJuDjTzmTuyxvCUji0BKmfL+cX2yPnnJxqgzR0YYXDgq9WFWVZJ4st1TiBSKn+e6R8JC/N76WxHsveYmElL04MjrjgwH5bytPXYdsi6xbYejhrGUKZ0yaHVJJlAcs8T63FvnNTH6IRJzNnCHZmGx2ELvfrl8zmf8siT+z4qd54HpgTeuRW2iPmQYx3mGrxZrJEAG+XL/XmfQ2MBiNY57DPTRt9Mk15978nEsM7hDr5OwrkaodJDnCvIDtoH+gdWbI6nv1X9ez68QPKrAiATusO3lBBncikiefGCm6yk76kPSTxZFWZLjhe+LLS1ifFwJ0r5p+huPNHGI -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Metric Tag GET

- - - - - -**Required Permissions**: `Metric Get` or `Metric Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a metric tag's data. - -
Schema
    metric_tag object
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/metric-tags-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/metric-tags-list.api.mdx deleted file mode 100644 index 340ad879..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/metric-tags-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: metric-tags-list -title: "Metric Tags LIST" -description: "**Required Permissions**: `Metric List` or `Metric Admin`" -sidebar_label: "Metric Tags LIST" -hide_title: true -hide_table_of_contents: true -api: eJylVU2P2zYQ/SvEHF3F3hToRTcVKNo0SXdRO6e16x1JY4mxRDLkKFnV0H8vSMprre1NF60vsqiZx3lvvg5QkiusNCy1ghRmsz/pSyctleKObCudk1q52SwVDx+JrSzEB+n4QWj7dJCVrVQPkIBBiy0xWQfp/QEUtgQpOG0ZEpAe/UtHtofk7M5VTULnn6lgsadesBbeR3BNwpLrGnYi7+eQgCtqahHSA3BvAjZbqSpIgB6xNY0/CrcOQ/Ls/i264jyGC7Bc64ZQTdHYdjTFMljRv+JIxVSRneK8nYJIptb9F5SfhmGTgCVntHLkvPGPNzf+8VzPTPy+vP1D3EZJC60YpZKqEqgEWou90DuBTSPakEAnGCvn9fWmpNgjojGNLNAjLj47D3u4jDEmzWfeakOWZQwqErykMiRRwGskW6lk27VeqgRYMzbXAWLIWx/xxCCw8pKe3fxSgOV1cMbq+8XV6ChJ+hthGX0KS8hUbpGvue60bf0XKJHpDUtfmyefvN92juz2pXg6U06wVdc0mB/LMnnlXUeM53e9gPV0txdDcuAcu3yFFQzjL2Sh1iWkUFFQF7mGFBbT5CTgyH49zoLONpBCzWxculg4VGWuH+eYuxYtN/280C344nZUdFZyH5w+ObKZke/Jv26mn5e+EmMup0aneogHY4/VMVnnYycT3ldkd+/Ee+rFTsf/2HGtrfw7JHouZrOPnWORk5AqjKQos1hDZuQb79jrzkZt0cjtnvo1zGaQHNs9m+IdO91/+GsEWK/der38IYgu1U4HHqP4ORZ7UiUk4KWMcb+d38xvLtkocWtIeQZLQ4Xcjd0ruEYW0TYnFyhkP4+6B8Ke+Ddt935CfJNcB0KCHg1Z2ZJiJ4zVlcW2RZYFNk1/nBVY+MIcEmhkQcqFzh5Z31ltrCRG2wdiRjtuUU0sxu2xwsqJD++Wq3NGh9M4+l9baSwJpkdemAalCl1hw3yJhXv/bKpsEqi1Y398OOTo6JNthsEfx1ntK7OUzndPCekOG0ffifzVu+1qmHtf1ccN+hWbzpuA3yUXEZxMx2X3GvNxn73G9Li1TrYb/2JlHCP3myE5NppXKDplRUFmGvvFWvEoT9Pk119WMAz/AIDN7sU= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Metric Tags LIST

- - - - - -**Required Permissions**: `Metric List` or `Metric Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all metrics tags. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    metric_tags object[]
  • Array [
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/metrics-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/metrics-list.api.mdx deleted file mode 100644 index ececb832..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/metrics-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: metrics-list -title: "Metrics LIST" -description: "**Required Permissions**: `Metric List` or `Metric Admin`" -sidebar_label: "Metrics LIST" -hide_title: true -hide_table_of_contents: true -api: eJztHWtz2zbyr2DwpRdXtZ04N73TN/Wm7fX6SCZ27kvkMhC5EhGTAAOAtlWP/vvNApREShRJvS62g850qoLAYrHYFxaL9QONQIeKZ4ZLQfv05OQdfM65goi8BZVyrbkU+uSkTz7+DkbxkPzGtflIpFo0DKKUi4+0RzOmWAoGlKb9Dw9UsBRon2qpDO1RjtA/56CmtLcy51UMRI4+QWjIDUyJkQTHEBMDUaDzxGgymp7SHtVhDCmj/QdqppmFbRQXE9qjcM/SLMEmO+ts1qvMHzAdruKwBmwkZQJMlKEZlUMZVsYm0AqHCwMTUGU4L8tAuIFU7wLl72Uo8k4godvALCiUMWNAYd8/e9/SWY+qYp9pf8wSDaubMiAJ14bIMbEzBTzSZCwVGfPEAMLsEQ244wYiMpqSUKYp06eVvXjZe9W7oCWkDbAOSz8AzjjRPihf41w6k0KDRsxenZ/jf1an+8/lmz/IG8e6oRSGccHFhDBBmFJsipiwJCGpFRQ7E/YCYRAYy7KEhwyBnX3SCPFhnRZOLpAWSmagDHf4OB5q4bme49e6XikXPM1T18tIw5J2YMUqSh3tInE7V7DZhHRUM8msRyeSJUHtxxIG35/PegUbNYn/FU8BNcgPUt4g7MqONQ6MgbBU5sLxD4IZwVgqIIyMpLzBfY2ZJiMAQVIWAUJ34JrA2rUhtMDIgIUxh1tIkQFmPQrjMZKpbrzAvflAM6m54beocwRMWPEzFzdC3gl6PetRpsKY30LUrMestMx6dCxVykygjWrG+mGmEUEdsqSef6pcpiDkukphkaejak/cv1uW5BBomasQgoI5ps2o0NmCjaaBk+T2AaECFPKA1VLXUYH2acQMfIebUx4zmga5tgqvfeV5FpXmEXmSsNHcbvQ6zjuHUZ13A6wVqdld5tolKctVGDMNW0nRgCBaVusaxUInNfKOpExMyRyiJkyBlSEiBcEvaGVyRUoaUe+/je3E2U542C0zTNVBrW7WoiuyKwR5lkgWBblKmkl3FiqZvVfJ2cvz8/uX5+dnL08zMTkyN1fsQITG0aSFedqM6e9M3YDhDjlIGa9d2QIv12OG6pIbC+C9dkzYCck1MetAgJotWYqZ54tHzReNe9eI9Dq5t9pHwyZ7ODebnZiFrqYhV2GeMPW3nyVLXtDC8zFs0jgQO+yu6KuD6/S8noaxTOSEhyzpX6lcG697n7mM7ax793VxPF88ar44oO5FzdWgTqu6EP+9YpMXFYyKxrW2SrsNKPx/lXYRW9igboGluytruMd4xwKn9kNAuxtfYQyv1J+x8HqH2vPFkZU6dt5D3TbzpIbaPfec9Gg4adbJ+C0t5hWw9AVdgYKNFjTcZ6A44t7IUstuO9rVlZhdu8k0oE1QmnZmsVFsJfy1YUu0YaZlApULUexFBLeQyAzn2Usba8PUvhBktjuA0vLwA8aa8yQJpNjr4DCHccsUZ6IJUM1mnPdoyu7d74tZjyZMm0ADiICLIJQR7EUuoeZY1d/DLKcu80eJTIhSBioEYdgEdB0my/uv4TB6eDUbDs9WflTY6uL12cXF2cVFHbrLmQI5Doxi4zEPW4TlHEP2GirKdp1KIz7hTkgKqMEWQ7xD+rzNxS5Ieuf06+KRjs5oWYmukXqLa16uydK2f6NJeShiI7gJ3Pjj3a3N17ntBTVmNBR3Zc4VPyZffOH7Ta/mn44Ib0P/8nDBzRV2L8tdp4v3TPGUqWngclLKZw6XlPaCrvZpBfsKvR2WRxxEWCu+ZW/sYUhdLsKQ9h+YiPrD4Yfr2YyWQGCWBa+kdzSwZDzNpIlB8xo/0GVYRDys1xE4pf0UZJJXvdFlD47TIUPYQ0wQgWE8qe+KeNSkWMwWPIajITQoJ8FaCkutH7n31VwlMWDn8EP5JLlkmB8Xrcg0pZmOaQC41Fsp/ze5IvzNJWZIeLf5+etTH8f1fLF7HLfdt9puHzsF6uoU6mCpTKtXe6UPtDLBRk4v6eVOfW5B6U3hurU4RAmzWuRtj5poz5b2J5RizFuyMbqQY+uA5juIyA+5MY7apWBa1+BZLYH+W8CZ2ShRKEW09LaObKU7MEyTZ9jkEdav9XK+PgfE9soU3HK4+/JLBXHLlRS2z/zkOs8gLsWX3fRR7vzI67nPHWLOczc56dExVy42LnWuYK9zoQ3HHgRSxAwLwtzI8fggJ9XdYdTyzlvHJ2WeqQsdPzEx2YPtGhVQOWL/TPjTZr2XVrDIjV92h5CnLHEbwmrz6Ov6OkKGnWFnC0w2LGR99DiRzBQnSBY2EaF1bJDIO3ey3BlCnmW7QWgyYGX5bMknqhO0xSVn8SKr41XmHjLrb8ofva9e7NLmm/I1ZnyD3LNyLx60pSQfyoGozLh73KM111gbFt70Ryy8ARH5QMbzFwKfZez54piBjJ1DEyX7vZp3XPm0rh630OkrkPCsLg3s4fRvmlpBlkwDI+uIVsnL6TVOsCSUzXNeW88f0kB5ugCX0y15cD0/6EC2iy2uReZnDycAtLdyCLEZUtS+6y5+QcTdB5nRRa6RfaOdFmMKNWHf3M5/X3uz9bzVk4+/e744ch416s06FNY6NoVK1qHCXdA9W7ZN2bfP0NlKL+xFaewKCTqYbLQ+myy1s0zrGHp76+2t16uPW696e+v5wtvbJ2pvx+xWKo57coC3YV4gH7VAtgW1D+RhbE+8FUR/KniyJFvYhSWg9rlxPfKyXUvJrUKuzrNAAEQQ0VJiacp1ykwYoy9ldzjQ/C8IFLAwtj2LVvtibdl7V0fqEEY3BcPwmr6DEq5PxsG9c5kmyxU3KMPjXpp/KSrOyx8GK0RYUxKrN+OVbNx/vrp4bYFZdjnkk78lyB0wbAZen5Vje1ziHEvbHehQgdCxPEx2RacUrCa3YZlgbivqKXDIVUxN6xyvbULCCFosUnGjTf71jSYuJYssX652VFUlvHbXiQ6IrpafPEgWtRU/mWVdfQAFVjnapPeUia6FEpdE6HSx8BNP4L3tXvWYbLslQ4UoGzXLHY9M3MIL5//Alwox8EncwnHf2zcNdtoNgjj/3J5DWDhIn2QsgkjCwtNx9UxXX0zVpbynbAJnxbAR07DJwVqoBvxebHeQwLi82IZUEdsdQwzde69Sva3/Gu0bB/jQxXP2iLuGLgpy7nlK8rv9JXd7xclo9TLqTGxhoi8X42sMhjO+jUlry/F0Vt+xY2J9fc2OtkIf61fl86oeW9X9WuTO7Z013pKr2pTmul9JEwenWH6pfUGQSjmzeWN7rmDzchsLSvq8waerYhpDLCvctEwZbBWfdb5fBUb3roC6c1ZgIt0zm/6/gUW7n7Af/6P2dbVRpAXtqw5atJ+vu/XEtcIa4yxFf88KmMe1m7uHVH0dTC8t/j7Z88XjvE/2dTC/ak7ydTB9HUxfB9PXwZzUXGT6OpjeXPg6mJ5Hdgj8+TqYvg7m+txezT8dEfZ1MH0dzAY/0tfBXEsK8nUwvT71cVzPF1+mfISvg1mJQ/g6mL4Opq+D2S4nj7TOoK+D6etgPmb+9HUwfR1MXwfzq/LVfR3MWuL6OphfmRD4OpieL3wdTF8H09fl8mbrqagnH3/3fOHrcj3Ruly+Dqa3t97ePim96u2t5wtvb5+ovfV1ML8egfR1MI+5bNfi62D6Opi+Dqavg+nrYPo6mL4Opq+D6T3iR+4R+zqYX89u+zqYe9fBbGPwxkKOrvrjYf2JMptkuQpjpmGrp1kDgmiRsVTEKBbecDEhsbwjKRNTMoeoCVNAUhYBkYLgl+IZb+VlmzcXz1yB+Ei354vjRrq328f9Cp920NUbKvU2pVHNO+yu6FvTUDM9DWOZyAkPWdK/Urn2rvpzlzGfjOr54si6d6sS8LYs+mrqadG41lZp7/pEpVJo3hde9+z/CAuv71VNsvKXBbbGqADX9KcLNv2Ng8UjYPePnTyWEe3TCRhXKSZGXprjhO+j1a2Vvw8PNqzZp7Exme6fnWkmopG8P2UjnTJlkulpKFM6u7ZvqnPFzdQOws0aZPxXwP+9Ln++DGNInSSVOy3J4Bp6lGPpmtiVml8539IBwbFk8PYX8itM7WEWf7PcxFLxv+z59JScnPyea0NGQLggJgbiuIsM6SDj3+HAqcxdjCtgGQ9uYDqkJyd0fvamgzI8JIvFnfbpnwWA4VAPh5ff2l3gYmwT7OZUnz8b6tHF43768vT89Hx9NYK8yUDgCi4zCPm4OGETEzNTFPwagbZLGPxQ0N0uGBd+J5U9xN9xE9sFleqFaZIpOVEsTZlB5zGZnlIXBHePI/GahocgtLucdKt+q2SmOBimpu4RsNQmda88ix6OoTT57ZfLq9XVPMxj7LRPT07eFVeA5C2olGskgz456ZOPDgT5jWvzkUi1aBhEKRcf6cJvMXBvzrKEcVftzOlDx7AfFkJ03aOx1AabHh4wVv9eJbMZNn/OQTmOjLhGbRsVqrkBa6xc5rQ0uYEpMZJoqYylvgKdJ0aTkaVjLYo3yM0UR9DFU1osk1CDwbJrwHTYsXuGtzPdujpN0tZ3Ix0GJOHa2MgPKtIAq7khw7lKUlxMekSj8keTQUZTgnmRTLcQpjDsB0CqUMYHwMm5KGWUrovIqTXPH67t/ZVVRMhJbtAgDCEr73EpNHb2SeMF5nVJ0/784xWdzf4H/fJ8Mg== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Metrics LIST

- - - - - -**Required Permissions**: `Metric List` or `Metric Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all metrics. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    metrics object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • ]
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/notification-has-new.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/notification-has-new.api.mdx deleted file mode 100644 index 38cc10f3..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/notification-has-new.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: notification-has-new -title: "Notifications Has New GET" -description: "Check if there are new notifications since the given notification ID." -sidebar_label: "Notifications Has New GET" -hide_title: true -hide_table_of_contents: true -api: eJy1VMFS20AM/ZUdHalJgN58S0unMEyBKfREaEZxlHgbe3dZyQluxv/ekW0GJ5Rb64s9u5L83pOeduADRRTr3eUCUrj2Ypc2aw8ukK9pCwlE4uAdE0O6g7OTE30tiLNog8ZBCjdrSCDzTsiJ3mIIRV9l/Is1ZAec5VSifkkdCFKYe18QOmj0SQ4qfs4pWxu7NJJTJIORjKOtcQN8bNi6jDTCrOyG3N6tuTwfQQKCK4b0YY8Yw2MCTFkVrdSQPjwmEDBiSUJRgw/Z3edkLs+Nb8GYAlnM2vnt/v9G5jtJFR0biRUpckdbigeI6dmyKC6rhZ8qijUk4LBUQbTybBg/s4tW/qfKRlpAusSCKRkoufSxRIEUrJOPZ0q3k9Y6oRVFaJrHBEqS3GtzVySgVCWHFMab0/EetnGOfOzahjPFzYsUVSwghVwkcDoeM7rF3D+PcM4lRinqUeZLaAZ63im4blR+MMVJsFdUD7qO3UGvQE64oAiH3Z8YzTWT20tzRbVZ+u4bK8l9tL97wY+OvlUsZk7GurY1nRxmCpNgjzWx9lWcVUxxhsHO1lRP4ejoVfDJsB70wurFz77AdMrT6d0H0Pm0bulbHlaKdnwxW5PTBqlWHe7T0cno5C0bZ24COWVwFyh7HVHJUUwXOyduKUw+9cK2hJX41se1dSuztZK3hAw9B4q2JCdsQvSriGWJYjMsinrUGxEzNWKTQGEzckyKvGd9G32IlgRj3RILnqVEN4jYM4u5QDbXtDVfv9wfUtu9mv7fObabE6FnGYcCrYMm6aZw18/uA2xOtYl7lk7gZX4fE8g9i8btdnNk+hGLptHjzm+twS3jvBh46l1a/8P8f6W4Vpu8twM2WFSa0lptg9Eqel1dTfLiIaXV1ZhkGQUZZL1Zx3trQfvaNH8A+mEZ4A== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Notifications Has New GET

- - - - - -Check if there are new notifications since the given notification ID. - -## Request - -

Query Parameters

- -Ok - -
Schema
    - -boolean - -
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/notification-read.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/notification-read.api.mdx deleted file mode 100644 index 07325055..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/notification-read.api.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: notification-read -title: "Notifications Read UPDATE" -description: "Mark notifications as read/unread. If ids are provided, only those notifications are updated." -sidebar_label: "Notifications Read UPDATE" -hide_title: true -hide_table_of_contents: true -api: eJzVVc1u4zYQfhVijqnWdnrUzdvsIVhsN9gk6MH2BiNpbHEtkdzhyIlq6N2LoezGdoKi6K26iKJnhvx+ZrwHH4hRrHe3FeTwuxe7tmXa+EZYQQZMMXgXKUK+h19nM31VFEu2QaMgh69byKD0TsiJ/oohNIca0x9RQ/YQy5pa1FVgPVLsWJCYPaeVFWrTQvpAkEMUtm4DQ3bcQGbs9dtvT8IK7xtCB8OgV/3ZWaYK8sWxcIpe/V3DFz+oFBj0yS5gfEHeGndCQDQYDRNW087pa2Ju18ZW0SCTCex3tqIqM941vZHaR7rMZjJdqFComizdSa5vrYimYtNc5Kw9G6nJlB0zOTFdJD4rBBkIbqJCPBUrKshIZcdWesgXqwwCMrYkpPTqt7JDUT76qlf+XskS7ug/C6jEvCPHJbl/1CQ1sRFvWuVZMb7LtfFsjnTf0Bq7RqJm6SUnqr6t3rWL69qCGDJYe25RIIfKd0VDbwx0ebNTFs3tTTpsJDvp/S+0eqvRMFw6LgOx0uiGttWZckmQ0ZAtSe21D0OnKQGlhhymu+vp2clTHlszEu9GeffQcQM51CIh5tNpRFcV/mWCRWyRpeknpW9hOPHIveo5SvgYiefBfqb+hE8cNzKwSlJNWCV2z7mbG80187tb85n6RIiusZPas/0z3XZirq6+dFFMQca6RNgokVnCPNgPmtj7jp+UxicM9mlL/RKuriADh63eZX5aT3Gnu0MO3w8Flsu4XN7/knhXw357tfqnF2yDEn+06uj25KLFbKWGcmufgB8EKrDcklN+ldwR6PVkNpm9he/M10BOId8HKl9tJDWKGWMLignz/ONBicSQMvXseWvdxjxbqRMDhl4CsW3JSdT5smFsWxRbYtP0k8OMxVJbdMigsSW5mIAdaLpjH9iSIPeJieCjtOhOIs58Z9SJ5vHuZv7w6RLa/nUc/I/m4uhcoReZhgat095PfbE/tNICdtdqq7PBmY3GWGVQ+ygatN8XGOmRm2HQ7Z8d8WGm7pAt6lTJF2qdQ1to/221e+C3kbUPD3oVDW+6sZkuBuqQHTPmZUlB/jF2dTIY7h4fIIPiMMNbX2kK47OiwGfIYQlL0H+9MIJT2+v+Hhp0mw43Gj+W1ecvxEnKGg== -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Notifications Read UPDATE

- - - - - -Mark notifications as read/unread. If ids are provided, only those notifications are updated. -If ids are omitted, all notifications for the current user are updated. - -## Request - -

Body

required
- -Ok - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/notification-see.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/notification-see.api.mdx deleted file mode 100644 index 5bfe09a5..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/notification-see.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: notification-see -title: "Notifications Seen UPDATE" -description: "Mark all unseen notifications as seen for the current user." -sidebar_label: "Notifications Seen UPDATE" -hide_title: true -hide_table_of_contents: true -api: eJylVE1v2zAM/SsCj5mXpDv65mE7FEXXAGlOSVfQDlOrsSWVorN6gf/7QDnt0uw4X0xT/HpPjz6CD8Qo1rvrLeTww4vd2So5lkSQAVMM3kWKkB/hy3yury3Fim3QIMjhbg8ZVN4JOdFTDKE5lZg9Rw05QqxqalGtwNpR7FiQmD0nywq1agwZSB8IckBm7GHIwO814OQtvW8IHQyDzvbSWaYt5Ou3Sin64b2GL5+pEhj0yS7mvkXeG2wa07lI5Iw7wx4NRpO8O89GajJVx0xOTBeJp5CB4FPUvueMRe0cqerYSg/5+iGDgIwtCSlI/W5Jaq9Mh05Aj6WGHGaHq9mH9rOYyI/EhzH1CB03kEMtEmI+m0V029K/TrGMLbI0/bTyLQxn/ZdK+cjyKhIXwd5Qf0Ykjo4MrJJRE26J4ZKjwmiuKRbX5ob6RIba2Ent2f5Ow07NZHLbRTElGesSWTvPLYrZQBHsZ03sfcePSt0jBvu4p34Dkwlk4LDVWYrzeoo7zQ45/DwV2GziZrP8lG7dup1POKw0SRFY7cltIQPlapz7ajqfzv9F48xdIKcIloGqd7qN1ChmjC0pJgjF1xOxCbAC/+V5b92T+WWlToAMvQZi25KTaAL7J8a2RbEVNk0/PS0FVjKqurEVuUg6+Qn1gn1gS4LcJ2DBR2nRnUV8EJdZqh5Xi2/F/fdLaMe/C/i/uh7VIfQqs9CgdbqBSXvHk1rXcLjSq/sgfNUdqfxrH0VjjscSI624GQZ1v3TEp5U4IFss9erWD0P2pjyV+F4FCkVVUdDlOGDTjUq9+KEM54u0WN3DMPwBftunnA== -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Notifications Seen UPDATE

- - - - - -Mark all unseen notifications as seen for the current user. - -## Request - -
- -Ok - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/notification-summary.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/notification-summary.api.mdx deleted file mode 100644 index ccb99fc1..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/notification-summary.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: notification-summary -title: "Notification Summary GET" -description: "Get notification summary including unseen/unread counts and a paginated list of notifications." -sidebar_label: "Notification Summary GET" -hide_title: true -hide_table_of_contents: true -api: eJzNV1tz2jgU/isaPWZdSLpvvLmgECbc1oZ2d5KsRzYHUGNLqiTT0Az/fUeyCb7ANDvT2dm8QM79OzcdXrGQoKhhgo9WuIenwrA1SxwhzLOMqj32sAItBdegce8Vf7y+th8r0Ili0griHp49Yw8nghvgxnKplGlppvtVW5FXrJMtZNR+k8p6NawwyCs+HYEZyHRbDl4kKJYBN5HZS7Ck4hNroxjfYA8DzzPce8AGtMEeXgM1uQLsOUJkIJMpNXDinEhPHjbMpNYaefOzsOYPHk4UUAOrKN5HbFXxy/MsBmXNCZVRg3t4JfI4bepwmp2JtiJDzVm2BuAVRixECpRbjgK6Os9Z52kaCR7tqGKUm3cGqyB1gawZpO8FSBNbsKhoHprC/6lgKY0hPZtTqpIt28GF7OVydbEg1SRQAx8My+BnRbykc7Ej3tlermTfcqYskIdWoo8JqMCtYasFXUbjfNukFr5F/BUSU+0N4IaZfZSr84ltiF1E2JB79zz9rIPmY39xOwsmUUDGxA8J9vCC+JNoQiafSBD5gwEZNGgBmcw+t6mzMQkjMhgtHIv8OSfBaEKmi2j2ZVqxVGGECz9oSfufZm3i7XI8jmbTOvGekHnUXwYBmS7qnID4g7+i21kQDUh/FI6amv6YBItoEYyGQxI4X7fEXywDUvh4++f2tqHX75MwjIaBP23HXfBOyZmQRTDqt3Xq9JP8cOaP29JV6kl2GfpDcoRxF5DwbjYeWNj9u6qPgHwekS9RQP5YkrDufT4P6nGWsv3ZpIDjylXZFtUn7rgvftXY1R+K9iPQGDy34Mtt3l7dzbV8ZuWenc7zs3hu8sqpujj6JYEqRfdubcGLiZJcaaHeObU5t+CiROTvfotybtPyL1QaVamfE/WgGwE1nLVTYP+8xqkzBIOqPpAu7iTEeJLmK8Y3qLDaLXwhZ1wjyleIIkk3jNsyoJRpg8S6Zkt3bE3oRlsg0xqQJ9suSa6Y2ePew5OHJVU0AwPKCjfvsb7D+yGmGlZHn0zwDppTrZHZAkqpbuAYDdBaicxxpYIdE7m2umCDYtbqtxzcPVgsd/yW1FP61zTV4FVOvbdqMW5+/4jfMsy4gQ0ofDg8eTgDsxX2/NyALYqkZot7uLu76daS09VvF6kGtTsidy8S3hojda/b1ZSvYvHSobHOqDLpvpOIDB8q6QttcMWFstSgfMnuYV/pNFoQSsxboCvXd/UE+8jqIn8+QvewR2tRfKe52QrFfpTZvrqa5NqgGBDjLq9FOtAj9iX7YBX3IldRrkFFVLLoGfaP+OrqlGK/ag+XibWMv0sDj4/68TH8zU0B42vhcJSbLqbJM3A75jZXRdw3nevOdRsNRzMJ3CIIJSSnnjBbalAhG0PROP6nMrEOsAX+Xahn2/bfmdk6QOi0GTWSSmwUzTJqWELTdN8pfynQxI63PdZYAly7x71EPVdCKgbG1toCk0KbjPKKRHU2UPlDBQ3Joons9fSj5D8Y3KJ/DLyYrkwpK07K4l4qevoB725scRsr6tjXTx7eCm2s3Ournd2lSg8HSy4mz8050zROK7N2Ee8v3wFn8T3b2Tmtgh1NcyvkJs69ZHZH9x6eDt5xlCyKQstPEpCmotX62VjbDra+h8M/afD/vA== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Notification Summary GET

- - - - - -Get notification summary including unseen/unread counts and a paginated list of notifications. - -## Request - -

Query Parameters

- -Ok - -
Schema
    notifications object[]required
  • Array [
  • action_rationale objectrequired
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/permission-categories-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/permission-categories-list.api.mdx deleted file mode 100644 index b0070f94..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/permission-categories-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: permission-categories-list -title: "Permission Categories LIST" -description: "Permission Categories LIST" -sidebar_label: "Permission Categories LIST" -hide_title: true -hide_table_of_contents: true -api: eJy9VcGO2zYQ/RVijhvV3hToRTe3KIokbXcBb07x1hjJY4uxRLLDUbKqoX8vhpLX2rWTLHKIL7KoN48zj/OGBwjI2JAQR8g/HMBhQ5BD9CyQgXWQw78tcQcZbCiWbINYr6t3FRlffKRSzJ46I95ojJGKDFNsa4mm6GaQQSwrahDyA0gXErewdTvIgB6wCbUupV37Pnuy/xpj+TyHM7LC+5rQTdmEW5pyBdzRN3msE9oRT3leT0msUBO/h+WXvr/PgCkG7yJFBf98fa2Pp3ouzNvlzd/mZpC09E7QOut2Bp1BZuyM3xqsaxOIGxuj9c6UKLTzbCmq0BpDTpQaQ6htiUo9/xiV/3Ce7HB6kEFgH4jFDtmd+Ncn/klYSkaVSIp8k85uLujTZ6Ouz5uizyb7/8hdnxzGhe+jFN36MnOfgVhJvXz7mD/0l9d/O8naj7/n7jqBzQlt/nyzvIMMGpLKbyCHHaXKUSrIYX754DKIxJ+O9m65hhwqkRDz+Tyi2xT+YYZFbJCl7malb0D7NVLZspUuBb2PxItg35G+3k8/L7WnBsWnoNOpDQujbSrCTTLH887XWLO4fWPeUWe2fviPrVSe7X+pi2fm6uqvNoopyFiXpszWc4NiVrAI9icN7HzL6zYSrzHY9Z66FVxdwfHMYTHlO5pXP/wzEqxWcbVavkqHad3WpzrGwyuw3JPbQAYq5ZD369n17Pq8GmduAjmtYBmotNvRh0YqFDNgC4qphMWvo+6pYC38s+e9mv6zlSoVZOghENuGnEQT2O8YmwbFlljX3dH1WKrr+wxqW5KLqcPHqm/ZB7YkyF0qLPgoDbop4mutdtkWQg8yDzVap9ZIPXUY2/DDF+bHfQaVj6KAw6HASO+57ntdHoap9tnGRixq2kC+xTrS2e6PA+7ll8/FhPfao8cr7hPWrUJAh/1ZBifoeBu9BD5eOC+BHq+VE/ZeX9gqOLktO9pGFRqCFmVJYZr72bhXlscp8cfvd9D3/wM5/7lk -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Permission Categories LIST

- - - - - -Permission Categories LIST - -## Request - -

Query Parameters

- -A JSON Object containing an array of all permission categories. - -
Schema
    permission_categories object[]
  • Array [
  • permissions object[]
  • Array [
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/permissions-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/permissions-list.api.mdx deleted file mode 100644 index 8542133c..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/permissions-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: permissions-list -title: "Permissions LIST" -description: "Permissions LIST" -sidebar_label: "Permissions LIST" -hide_title: true -hide_table_of_contents: true -api: eJydVcFu2zgQ/RVijqlqpwvsRTcXKBZtdzcBnJ7q1BjJY4u1RHKHozaqoX8vhpITxTaQYHWxRD4+zpt5Mz5AQMaGhDhC/vUADhuCHKJngQysgxz+a4k7yGBDsWQbxHpdvavI+OI7lWL21BnxRs8YqcgwxbaWaIpuBhnEsqIGIT+AdCFxC1u3gwzoAZtQ61K6te+zZ/evMZanMZyRFd7XhG7KJtzSlCvgjl7ksU5oRzzleTclsUJN/D8sf/b9fQZMMXgXKSr4j+tr/Xmez4X5tLz519wMKS29E7TOup1BZ5AZO+O3BuvaBOLGxmi9i5peRZITJcQQaluiEs6/R2U9nIc41AwyCOwDsdghpgnrBJwuVtVJ/YskdnMhF3025vDUAP2JpS7slyi089ytLzP3GYiV5KDbx/ihH59Txz5Bovn74/IOMmhIKr+BHHaU1KBUkMN8mowMIvGPY3u0XEMOlUiI+Xwe0W0K/zDDIjbIUnez0jeg9Y5UtmylS4e+ROJFsJ9JP++n20utzpC7Kegp/8PCaLuKcJPMdeocPWsWtx/NZ+rM1g/v2Erl2f5KfpiZq6t/2iimIGNd6tKt5wbFrGAR7Fs92PmW120kXmOw6z11K7i6gmP1YDHlO5pfN76NBKtVXK2Wb1JZrNv6pGMsT4HlntwGMtBUDnG/m13Prs/VOHMTyKmCZaDSbkdHG6lQzIAtKCYJi/dj3pNgFf7T816b5qeVKgky9BCIbUNOognsd4xNg2JLrOvu2D9Yav/0GdS2JBeTV0fVt+wDWxLkLgkLPkqDboo4t9VlWws9yDzUaJ1aOznpMFru67P+u8+g8lF0+XAoMNIXrvtel4fBo57a2IhFTRvIt1hHOrvzcSy8flBfDHOvfjz+HfzAulUI6GA8i+AJOk7u18DH4fwa6HEEP2Hv9YOtglNnZccW0QwNhxZlSWEa+9mQVJbHOfDXhzvo+9+KPGz0 -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Permissions LIST

- - - - - -Permissions LIST - -## Request - -

Query Parameters

- -A JSON Object containing an array of all permissions. - -
Schema
    permissions object[]
  • Array [
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/platform-alerts-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/platform-alerts-list.api.mdx deleted file mode 100644 index e7ab845d..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/platform-alerts-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: platform-alerts-list -title: "Platform Alerts LIST" -description: "Platform Alerts LIST" -sidebar_label: "Platform Alerts LIST" -hide_title: true -hide_table_of_contents: true -api: eJxtlMFu2zAMhl9F4DHTknRH3zJgGIp2aIF0pyQraIeJ1diSStFpvcDvPtB2u6SbL5Yl8Rd/8pNPECIxigv+egsZ3Fcou8D1oiKWdOuSgAWmFINPlCA7wZf5XF9bSgW7qIGQwd0BLBTBC3nRVYyxckUvO3tKuuUEqSipRh05obrXiqynixuUa0oJ96RDaSNBBknY+T10dpz4uGCBfFNDtgLndwEsvCB7XdhYECcVfXT0oOGdBbc9E/NNnRODBd2GAhlsQ5NXBF2n3p8bx7TVQ94SHNPpZTZvuUHIn6iQv8kCMmMLnT4WBPdJNS4LrOGJioadtJCtNhYiMtYkxGn4vqzzW7QZws3t9fIBLNQkZdD27Un7FVFKyGB2vJrFMeARh/P0OD4O6idouIIMSpGYstksod/m4XWKeaqRpWqnRaihO0txqS0cmvUzES+iu6H2rJI4TFhwmmxJuO3reulhYTTWLO6vzQ21ZheGMTZSBna/e2imZjL50SQxORnnjZRkhuaYNSyi+6yBbWj4sUnEjxjd44HaNUwmYMFjrbkszvXUd587ZPBrFFiv03q9/NR3ucdHfYzQ5FgcyG/BgtZqyPtqOp/O/3XjzV0krw6WkQq3G7E3UqKYYW9Oqbew+DoWtjesxl8CH5zfmxcnZW/I0GskdjV5SSZy2DPWNYorsKra6XjJsNBL1lmoXEE+9RdjdH3PIbIjQW57YzEkqdGf7/g/Qheu3hsq9CrKkPPKdY/LacRrBccrZe0DYBsLZUii66dTjol+ctV1Ov3cEI+QH5Ed6g3LVpvOvoGiRB6UJ1gUBUUl+YhVM4D14X+iVL5T//3bA3TdH1SkpZM= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Platform Alerts LIST

- - - - - -Platform Alerts LIST - -## Request - -
- -Ok - -
Schema
  • Array [
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/role-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/role-get.api.mdx deleted file mode 100644 index 0ee46af8..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/role-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: role-get -title: "Role GET" -description: "**Required Permissions**: `Role Get` or `Role Admin`" -sidebar_label: "Role GET" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1z4zYM/SscXNq6Wtvp0Tf3YzrbnW0yyeYUpw4swRY3FMklocSqR/+9A0qOlQ8n2532ZEsknvCABz7uoKCYB+1ZOwszGI3O6UutAxXqjEKlY9TOxtFopm7OnSH1O/GNcqF/mheVtjeQgceAFTGFCLOrHVisCGYQnKH3BWSgBdojl5BB6PFhxqGmDGJeUoUw2wE3XqK0ZdpQgDZ7ktunkpQulFsrLkmlBLhEVo2r1b2OpWKnNsSqQEa1Dq4aQ3stH4ze2UhRvvHTdCo/j4Hn6o+L0z/V6eoz5axyZxm11XajUAmF72KCHEMGskaWBQK9NzpHgZh8joKze87FJUgpUHCeAusuC0F9e5cuXq5KV92HlchB2w1kQFusvABD6suzAr4akZiqe82lQmOUPzRf0TYnz6qOFNQv55e/CnAeCJmKJfJLuGsXKlmBApnesa5oGLNqloK1PMav9sUA29bG4EqS7PTydd/aYzz+1hGsR4ozxN2Wh9RWzhnCvp5rrA13mE+6uN82KOsaTaQ2g3VtzBKlKf8iaNCCQQCGgI2MFFMV39bQAeRouSWjo4uH+P9ar2+pUwSDTBsXmiPZtRmw5iTfw1kFbds+0trbeWPIS31Hxde1Be+QMbyE+lhdD1uXa21oWXvjsFjWwbw+iJM8OH8ZzORkOt2eTKeTk7Hvq/F/jVwGlba6qiuYnaSueAxc9cfc8Uw/Yrgl7ltFFeoXmT3k1e0YNu0yPumiHOmpf6mFFXHpCpjBhlLPxD5mMBG5xsmu85YWMogU7vbGk8oLJbOPs8kkoi1WbjvGVawwsGnGuauSJ0TK66C5SUGSx9zrDySP18PlCznPO5EMNx2GsXvRG1xJWKRyPnUXiVXzs/fqAzVq7br/WHPpgv47OchYjUYf68hqRUrb5G9d4dQC5l6/k8DG1aHrInq9vKVmAaMR7McL5kM86H1VFv7qARaLuFhc/Jgqru3aJR595VeY35IVq5ZSdnmfjKfj6XM2Vp16ssLgwlOu170Hdlbc7V1RTBTmP/d1T4SF+L0Lt2KsyWeEkKKtp6BFbVH54DYBqwpZ52hMs3dczEWKbQZG52RjOkx61mfB+aCJMTSJmHeRK7SDHd215bdPT5nsDmb+rbeeXgVMW554g53l9hPeyfUqna4RMpj1l6HrDEoXWZZ2uxVGugymbeX1l5pCUmAGdxh0d5Jc7aDQUf4X/RH0Co3v9yx+UN9wVzrCZy91Kzq/Q1PLE2RwK5Owv+K1122217/k3C3Oc7k4DMKe3Zlk2B7mXJrUtv8AQUyj9w== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Role GET

- - - - - -**Required Permissions**: `Role Get` or `Role Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a role's data. - -
Schema
    role object
    permissions object[]
  • Array [
  • permission object
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/roles-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/roles-list.api.mdx deleted file mode 100644 index d22b3e61..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/roles-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: roles-list -title: "Roles LIST" -description: "**Required Permissions**: `Role List` or `Role Admin`" -sidebar_label: "Roles LIST" -hide_title: true -hide_table_of_contents: true -api: eJy1Vtty4zYM/RUOH12t7XSmL35zL9PZ7m6TyeUpTh1Igi2uKZJLQlmrHv17B6Icy7ckzbRPiUXgEDg4ILCROYbMK0fKGjmRg8E1fquUx1xcoS9VCMqaMBhMxOO11Sg+q0CPwvru5zQvlXmUiXTgoURCH+TkfiMNlCgnMlhPMpGKkb9V6GuZHNx3W6Cw6VfMSKywFmQF+wgqUHgMlaYg0nooExmyAkuQk42k2rXY5JVZykTiGkqn+VN7a9Mke/fPIWSHMRyBpdZqBNNHI19hH8vBEl/FUYZwib6Pc9EHUYRleA/KT03zkEiPwVkTMLDxj+Mx/9nncyr+uLn8U1xGSjNrCJRRZinACPAeamEXArQW3moMTCzboCGGAue0yoChRl8D422Og4vV4pJ769CTitHEzI5zaJLI3KnsSmVUWZXMUSLJEujTAG2svaM2EWbx4M5zoeWnYWNNXhJUK2823SP5RY+WWPFdUdHS7HZNJHCdoSNRBfTil+u7Xxk48wiE+RzoFO7C+pJPZA6EH0ixvHc+aT1nrPm5/CqX97BNpTWkW2Unb7xri7F/1xms3t05aqRoctRk7fECKk0Rkxl7uRcXoAM2iVxUWs+Bi/IvnHoleL+GdiBn6eaIzh7u/P9rvb6mThYMEC6tr89Ex82nqJXv7s2XTdPsae31uMFnhXrC/G1lgScg8KdQ99X1bDpfKI3zymkL+bzy+uVGHGXeujuvRxfj8fpiPB5dDF3Hxv/VcgcPWo4OPJXd23o+0i/gV0hdqbAEdTKz57iiRb9od+Ggijya2/rFGpZIhc3lRC6xLRpQwQTFVzWRAf3Tdm63tMqCyIXJaBTA5KldDyENJXjS9TCzpeRBFDCrvKK6deL7p059Qv750D++4eERxdE32jVh/NDNwwIhb2k8HGnsK6ZXH8UnrMXCxv+hosJ69Xc7roZiMPhSBRIpCmXa9SESJmZy6tQHdqxt5WP1wKn5CuuZHAzktq3ktI+3ncp88FcHMJuF2ezmh5ZpZRa2zaNjPIVshSaXiWQqY9wXw/FwfJyNEZcODWdw4zBTi27gCiqARLRNMbQpTH/ueG8T5sS/W7/iad7OF05I4NqhV6yyIJy3Sw9lCaQy0LrejnfIWIJNIrXK0IT2EemyvvLWeYUEvm4TczZQCaZnwWIK4vPHm9vDXDa73eHde2MnBMI1jZyGOG275o5Cve/G/0MiCxuIP2w2KQS887pp+HPco1iJuQr8cOTdK/NCvG/eO08GuGIVb7fbJ9AVm0je844i2Jl2i+hbzLtd8y2m241yZ/vAP7yKL+j9Q5NsG4sZik7TjDeRntfR5scoz+/G77/dyqb5B3xcLKQ= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Roles LIST

- - - - - -**Required Permissions**: `Role List` or `Role Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all roles. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    roles object[]
  • Array [
  • permissions object[]
  • Array [
  • permission object
  • ]
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/segment-create.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/segment-create.api.mdx deleted file mode 100644 index 445b47b5..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/segment-create.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: segment-create -title: "Segment CREATE" -description: "Create a new segment. The name must be unique across all segments." -sidebar_label: "Segment CREATE" -hide_title: true -hide_table_of_contents: true -api: eJztWE1v2zgQ/SvEHLOqkwZ70s0NciiKRYom3YudFUbS2GJDiQxJOXGN/PfFkHIs+SNrBz0sFptLZJEznHnz5pHUCrQhi17q5nMJKdzSvKbGX1lCT5CAJWd048hBuoLLiwv+V5IrrDRsAyncPEAChW48NZ5H0Rgli+Dx/IfjKStwRUU18pOxvJ6X0SFZq214kp5qfnhJwC8NQQpoLS7hJQEXQwq+lbqZQTrZ9lOEcMssX741Cxfo0e5GUVhtsorkvAqLdOs3bZ2ThQRm2tboIYVSt7kiDilYPMnSV6cYeG1Oma5odmw8OTrKWqt60523spkHZ7E2WRzYM2EmFWUN1m+MOvmTjozlJCBPwTAE0jqcUybLo4FcEyNrHdnTDdHvgtI3QE8fvKyDzZHOX7irHltpqYR0MmDfgFk91vQZ0av2Vm37lezX7bUma7y3sdyL0wCDkNz9a2/q/AcVfieVrsF25yXbLce4ZRGZTOkC1X7ulVTrEFBvNNdaETY8rNCx+Vw22Qylai2dVK+e+SlmBeth0Xq5oOHi7khuoS0quaByf1IRxCxWyCiN5fGs/aHzzEt/EE2D1q+1dGc4wPGGDNi3hqlGuV9+6NmTbVAdn0Vryvc17drwpGr++xViT7P0W+NQH2wT/E3m9lh5iIJ9eg3I1KfOgChrWgxJsLfAg+K9W4/ud8X19WBwhCr9d4m3QNVS5nRrC+aGtzJv/SGV6J3u9owflID3kftXcOFAdsNcusgPMicB/bBPkbfi7Y6sm2NpsNuzNbLh7/sOzN8b+diS4Gb0FmXjxUJqhV2Q7zxJ7409AWraGtLJDJWj+wSaVinkKqThDavzzgl8t7DDA/kWHpqP/52XHRQSwLKUnACqr714w+oJdFsV/IlKliHPa3b0rbtzrEG8vNwFcWMiWMOCbP0P3RC67WaGeKsTKBp6Eh1/R+KuIsGtIerWeZGTaCNBsbDaOYFKree6ESTgce44+u6mGELnXcVKv4R0cp+AQYs1eWJw+DfnTM5/0mW4nm0g8Lald5ftoA79k4AdrYVb5erkY6gpB5y9t5yxQh20AbBYx5p8pfl+brRjZwb52gTni4/n69oESbKLiPoKwm0QKu+NS8/PHTZlrp9HmLsarVfLUaFreOmV7pZhjsh+d2THRn6hZQ8UjC8SkMykirAM8j4k2FiwrRh//Sy+0FLMdHzG1lfayp+hsCNxdvZHxzTZCF+RiHuEmMLYyA9suNStjWKPRmYPtJzC2dlawVMY9/1x3iF2SOGvzsF06qbT299CCZlH3zYMvH7G2sQDcuftdesc5vL6+hBf+ltfM9MBq66MORYP1LAmcT2iv4+ji9HFLmKNuDHUMEq3hgo56+gvfIVexLk5uQDT+FNXvAAqg/uk7YNs5uJJ+iqAJujZkJWBEMJYPbdY1+hlgUotR51GYuHjlxYlC2Kx2GDB1LSSPNooV0y3GpvejI6b4urb9fjuejuf1aabf5HaRPZ5evbnRqEMV6TuS0dsggksPm624yBHFTdJOoHViq/K3616eeHXjy3ZTqIWaGVU88l9+GYR6Mx988Csh6uYxYe7eK8OFAhNsKVPfIaMFuOiIOPfnHvf6+OvN7d3fJXvNLHWJdtYfOJvbvgEKUxhCny4CMiGvgzvV6Cwmbc45/nRL//9DV+Y57s= -sidebar_class_name: "post api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Segment CREATE

- - - - - -Create a new segment. The name must be unique across all segments. - -## Request - -

Body

required
- -Ok - -
Schema
    segment objectrequired
    created_by objectrequired
    avatar objectrequired
- -Unique constraint violation - -
Schema
- -Validation failed - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/segment-delete.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/segment-delete.api.mdx deleted file mode 100644 index ed457f0f..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/segment-delete.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: segment-delete -title: "Segment DELETE" -description: "Permanently delete a segment by its ID." -sidebar_label: "Segment DELETE" -hide_title: true -hide_table_of_contents: true -api: eJztVE1z2zYQ/SuYvbR1WUl2c+JNHfvgSTvxxEkukupZkisREQggwNIxq+F/7ywJ2orkdKY99yQIH8v33r63B3CeArJ29raCHO5p15DlazLEBBkEit7ZSBHyA1wtFvJTUSyD9vIGcni3hwxKZ5ksyyl6b3Q5VJx/jnLlALGsqUFZ+SDfYz0WpBBcGFaaqZFFnwF3niAHDAE76DNwe7mQdgvnDKGFvhdsX1odqIJ8NVUabm+ea7jiM5UMfS/X3yzenKNPfJV1rLautdV/J/MqzgzItg3kqy2aSJsMbGsMFoYgH3b67BURpiKRg7Y7ONPkhLuTDqQqZ9wzwKrSQgDN3RHe4esZsGbBAp/Q6GrgeSOF3qe2T9JdXZ1L9/JEbVEb+l+6c+n67ES0OwoNWrJsOlUNIVOoYjJh0SnNUd1ezyADxl0UiMmhA75IZRs0d5CvNhl4DNgQkyiwOu3Oh5qmuj9EZduGgi7V7TVkoOXcI9eQgcVGOOgKjoXh0FJ21K2tCw2y3LP86xU8C6Ut044C9P0mg4a4djJDqml4DN/IYf54OU9Q4vygqx6ESXicgLfBQA41s4/5fB7RVoV7mmERGwxsulnpGuiP2N8LrtE4HyOFpddvqTvqPY4biWhNWFGA00YslbxVy7tb9ZY6tXXjGluuXdB/Df2cqYuLP9rIqiClreKa1KiEWsPS61/kYefa8NBGCg/o9cOeujVcXLwIuzyuB0lTOfgzFViv43p9//PgTG23buCRnFVguadhJIlWI+7L2WK2OGdj1TtPVhjceyr1NiVPcY2sxrsFxYHC8rck7EBYiH91Ya/tTn3VXA+EFD15CnromPLB7QI2DbIu0ZhulnKOJY8D2+iSxPD5YWItaQmaGMMYOe8iN2iPbkxz9/rm95sPN6d8Di+D5N8kZmw/0xPPvUFtJf6DuQ7Jiit4vBzMlyKVQa4rCVbtIsvx4VBgpI/B9L1sf2kppLA9YtDj8JGo6Sjr6nkWfBf9j+9TqH5S/5DIV5FPbrZi5Uc0rfyDDPZidklsv+mzyd6CajxYliV5PnpyNoi/CWtqQN//Df+Fw5U= -sidebar_class_name: "delete api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Segment DELETE

- - - - - -Permanently delete a segment by its ID. - -## Request - -

Path Parameters

- -Ok - -
Schema
- -Segment not found - -
Schema
- -Validation failed - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/segment-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/segment-get.api.mdx deleted file mode 100644 index 3a9a8e3e..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/segment-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: segment-get -title: "Segment GET" -description: "**Required Permissions**: `Segment Get` or `Segment Admin`" -sidebar_label: "Segment GET" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1z4zYM/SscXHbrav3Ro27uTGdnu90mU29OcepAEmxhLZFcEkrsevTfO6RkR0mcpNNOfbFDAg94APiQAxTkc8dW2GhIYTT6g7437KhQl+Rq9p6N9qNRqm4XtKlJi/pIcquMeziYFzXrW0jAosOahJyH9PoAGmuCFHxn9qmABDjEsCglJOD6QJCKaygBn5dUI6QHkL0NjqyFNuSgTZ4k+bUkxYUyayUlqWMaUqKovWnUPftSiVEbElWgoFo7U4+hvQkxvTXakw9hfppOw9dj7Ln6dXHxu7rIvlEuKjdakDXrjULVE3nnI+oYEgjXpCWgoLUV5xhQJt98gDo8Z2QiaqiUM5accJdID/y2IRfny9NV+nTjxbHeQAK0w9pW4eg31JsGN/SsmK85hTo3ntw7r6qB/x1WDa28aVxOKxRxnDXyRvyhf+4IhYoVyjmftXF1uIEChT4I1498sv0qZLR6qRKNLQbYuqkqzEIC3Yj9s1hHjMexXsAaxH7I8e1OostLvqMhi8yYilAPy7bGylObAN6hoDuH+jirk+lqzRWtGlsZLFaNq15vziR3xl65ajKbTnez6XQyG1u9+V9blUDNmuumhnQWR9KikyeP4EymX9BtSbhLjmrks8xOeXUWbZuAsESAKx96NTjo1QPa7pNATVKaAlLYUGxbEKsUJv0b9ZPDSc9aSMCTuzvqXawzlCLWp5OJR11kZjfGzNfopNqPc1NHEfKUN45lH51CQnPLnyn8eTO8XgT16KZlaHSii91BL6olYRHr+lTOgq+aX35Sn2mv1qb7jY2UxvFfUa/GajT60nhRGSnWUVO7CqolzC1/CI5707iunWh5taX9EkYjOCoPzId40Gt5uPizB1gu/XK5+DGWnvXaRB59CzLMt6TDegil7PKejafj6XM2Wl1Y0oHBwlLO615xO+3vbDPykcL8577ukXAgfm/cNij5PUsZCSnaWXIc+6qsMxuHdY3COVbV/qjvmIeZbBOoOCfto871rC+dsY5J0O0jMWu81KgHFqed+cvXp2QOD9vjv23dfhyEdjKxFbKOGta9+W56r48bxkMC6cM+vkmgNF6CweGQoacrV7VtOP7ekIsDGdTecacw1wco2IffRS9Nr1B6f2T0g/p36/oFYsfh12Hy4yaCFCCBbXgbg/812ps2OT6KkHl3P89zsjLwfLa2wws8SUBoW9v+DeRMJw0= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Segment GET

- - - - - -**Required Permissions**: `Segment Get` or `Segment Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a segment's data. - -
Schema
    segment object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/segment-update.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/segment-update.api.mdx deleted file mode 100644 index 3697e99e..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/segment-update.api.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: segment-update -title: "Segment UPDATE" -description: "Update an existing segment's fields. Pass only the fields you want to change" -sidebar_label: "Segment UPDATE" -hide_title: true -hide_table_of_contents: true -api: eJztWMFy2zYQ/RUMLm1dxnbcnHhTmhwymU48sZ2L5WpW5EpEDAIMsJStaPTvnQUoiRIpV9L0kOlEF3EA7HLx9u3DggtpK3RAypoPuUzlDU5LNHRX5UAoE+nQV9Z49DJdyKvLS/7L0WdOVWwjU/npUSYys4bQEM9CVWmVBY8XXz0vWUifFVgCP1WO30cqOkTnrAtPirDkh2UiaV6hTCU4B3O5TKSPIQXfWn+ayPR+10/mEAjz0Xj+0iqYAYHrRpE5W40KVNMivKR5v6nLMTqZyIl1JZBMZW7rsUYOKVg8qZyKYwzIVscs1zg5NJ4xeBzVTreWe3LKTIOzmJtRnOhZMFEaRwbKF2a9+o4HxnIUkMdgGAKpPUxxpPKDgVwRY1R7dMcbAnVBaRsA4StSZbA50PmSq+pbrRzmMr3fYt8Ws1qsaTOile2d3LYz2c7bOicrvHex7MVpC4OwuYd1bdrxV8yos5WmwLrrkt2SY9xGEZmRthnofu7lWNoQUGt2bK1GMDytwbP5VJnRBJSuHR6Vr5b5MWYZ62FWk5rh9sv9gdwClxVqhnn/piKIo5ihSlvID2ftVzsekaK9aFbgaKWlnekAxwsy4F6axhJUv/zgM6EzoA/fRR0OnxOKdmV4VDZ/fIXoKZZ2aeyrg12Cv8jcFiv3UbBNry0ytamzRZQVLbZJ0JvgreSdrEcPXXFdNwYHqNL/l3gz0DWOvK1dxtwgp8Y17VOJVnfXM79XAk4j93/BhT27295LE/le5iTSPvYp8k68Tcu6aUuDXc/RyIZv+hrmO6O+1Si4GMmBMiRmympogjyxk+6NPZFo6lKm9xPQHh8SaWqtgbOQhhFW504H3k3sdkO+g4fl9r/x0kEhkZDnijcA+roVb3h7IpujSn4BrfKwz/fs6HNz51iD+KYLYnNPEcaSmNja5D+h64Pu6qoL3cZEsPzjT+i60O3qoIwXYgFG4LPypMxUNALwixcThTr35+IavBfW6LmgAptRMbe1eAJDgqzICjBTHBplvMoxrBqyUMNQigbZubCTMMHbRU9ibPP5uUwkwdTz1hvmh33zae4UzWV6/5DIChyUSMjI3u9m/bbAVsSmLtGpTHx4x4LI8xWEi0FUdxk0dgM4uRqTFgvWoq4M/XEl1wlQhnCKTi6XD9EcPb21ebiV73o7kXKMVnd076H0b6fZwQfj8kSWReI0SXvHwfe0d3AyibfcB6gje0ukwvIHnapmXyG7qbyYvb5oSOAvFipfhnPMzVaUCZ8QZEFU+fTiwoPJx/b5HMa+BEd6fp7ZUi5bvLvhJMUM3Hl0g0p9xHkLPIgDDcUKhDz0BNvMHAi2FYPrD+IjzsXExmeoqbBOfQ+0OBdnZ3/VXA0olInlFTgohnJQqVdsOLe1ix0CVGr0iPOhPDvbUHrQ9icbNvPE342D4dAPhze/h/wwCz9v+Pv+Gcoq3qpW/Gu8rvuu7T2th/fxq80rZSY2gNbkdAzZI4YTjRMTHb4+vzy/7EJnxKcKDcN1U2GmJk0VCSqARFw7Rh/wGrxtshjQZZSfrHtkIXtSVAT0BD5X6FSgB+vR1EFZAqkMtA4axDULGcXvdFplyHq5AYN56hQSuKjYlfVUgmmtWB3bd9fvBrfvd/ez2IjCjyC4kcOEz3RRaVDhdt58ZIv1dC9nrzedIDeFaWwuC+uJpxcL/lZz5/RyycPfanSNVs/AqXgmslIrz8/5urr3ovLr50Y4fhMvCHpv5KuSNPMVLWUqZSIfuWJZ8EMP3NQoRxUn/ozvfnUbvzCtDDuSzbepaDHIMqzoxbUPLYG6vrvlb1rNKVHanE0cPPEBBE8ylUM55DhtgCNoTRhfSA1mWsOU10e3/PsHX130/w== -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Segment UPDATE

- - - - - -Update an existing segment's fields. Pass only the fields you want to change -inside the "data" property of the request body. - -## Request - -

Path Parameters

Body

required
    data objectrequired
- -Ok - -
Schema
    segment objectrequired
    created_by objectrequired
    avatar objectrequired
- -Unique constraint violation - -
Schema
- -Segment not found - -
Schema
- -Validation failed - -
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/segments-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/segments-list.api.mdx deleted file mode 100644 index 09217edd..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/segments-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: segments-list -title: "Segments LIST" -description: "**Required Permissions**: `Segment List` or `Segment Admin`" -sidebar_label: "Segments LIST" -hide_title: true -hide_table_of_contents: true -api: eJy1VktvIkcQ/iutvkQis4Aj5cKNSFG0WW9sBfu0OLhmpmB66ddW13g9QfPfo54ezBjwQ4nCBeiu+vqrd+1kiaEg5Vk5K2dyNPoTv9WKsBTXSEaFoJwNo9FM3C9wY9CyuFSB74Wjw8m8NMrey0x6IDDISEHOvuykBYNyJoMjlplUEf9bjdTI7OjVmwqFy79iwWKLjWAnoo7gCgVhqDUHkTdjmclQVGhAznaSG99hMym7kZnERzBex6Pu1bbNnr2/glAcczgBy53TCHaIxlTjEMvDBt/EUZZxgzTEuRiCKEYT/g3Kz217l0nC4J0NGKLwT9Np/Hruz7n4fXH1h7hKLi2cZVBW2Y0AK4AIGuHWArQWIUUwRN9GMbQc0cB7rQqIaJOvIULuTvmlgMWok/NIrBKhZNypGW2WnHfOQKOsMrWJbsokOwZ9HmBPd3DbmRN9efTsS+zK88gpMq+l1SXYTR0NaI+y9zWlmNh1QPohCD3QfwBd4yq4mgpcATOpvOY33h/qF4TAWK6Az+msHZl4I0tg/MDKPNPJm1VktHrJE7UvB9i21hryfSVk73xrj/H8rRewBm8fOL4dSaCiUg9Yvl6/a9AB20zCAzDQOdTnrJ5EV2ulcVV77aBc1aRfD86kIOdvSU8uptPHi+l0cjH2dvO/huqoakr0QGz6An6Z6WegLbJK5NCAOmvZE68k0cayVNwB3IYYq8FBPwVk238yaZArV8qZ3GAXN+Aq+uipemMh08N+SnTOlRWzD7PJJIAtc/c4hjwYINbNuHBGxrYXsKhJcdMpRRZzrz5h/Hs3vF7EPpVSZCh0aBjpoO++FULZOfO4gUZdMb/+KD5hI9Yu/YaaK0fq764zjsVo9LkOLHIUynbDKrlNLOXcqw9RsXE1pRiCV6stNks5Gsl9u5HzId5+BsSLv3qA5TIsl4sfO38ru3adHb3fcyi2aEuZyejKxPtiPB1PT62x4sqjjRYsPBZq3fd2wRWwSLI5hs6E+S+93zuDo+HfHW3j7PiuuOoMEvjokVQXS+HJbQiMAVYFaN3sJwkUMRHbTGpVoA1dc+utvibnSSEDNZ1h3gU2YAcSfUoFcflxcXNszu4wqf7jutJnBOMjT7wGZbvelWo9Je2Xw8i5y2TlAsez3S6HgLek2zYepwkes7JUIbaSsu87rxB/98ZzluM2ZvR+r+qGiZxJGTeMEwYH0X4Feo94v+W8R3S/yxxk7+IfUqmnfrlrs32RRQ8lpXlRoB9yP1k4IspTG/nt1xvZtv8AzKyoJQ== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Segments LIST

- - - - - -**Required Permissions**: `Segment List` or `Segment Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all segments. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    segments object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/sidebar.js b/docs/APIs-and-SDKs/Web-Console-API/sidebar.js deleted file mode 100644 index 744c39bc..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = []; \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/team-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/team-get.api.mdx deleted file mode 100644 index 94d51f56..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/team-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: team-get -title: "Team GET" -description: "**Required Permissions**: `Team Get` or `Team Admin`" -sidebar_label: "Team GET" -hide_title: true -hide_table_of_contents: true -api: eJztHV1z2zbyr2Dw0sanWkrSmd7pzb1pe71Om0zt3IvlYyByJSImARYA7aga/vcOAFIiRYqkvmpbwUMmMgksFov9wi4WXOIApC9ooihneIwvLn6HP1IqIEDvQcRUSsqZvLgYo483QGL0E6iPiIv8r6sgpuwjHuCECBKDAiHx+HaJGYkBj7ECEv8c4AGmGnRCVIgHWOTw8ViJFAZY+iHEBI+XWC0S3YsyBXMQOBts4HYTAqIB4jOkQkAGARUShRY8RY9UhkhxNAeFAqIImgkeX+LsTg8oE84kSD3Gm9FI/1cFfIX+e/3uN/Ru+gl8hXzOFKGMsjkiSE/hK2lAXuIB1u+AKQ2CJElEfaJBDD9JDWdZnws3IDWBBE9AKGqx0FC7W9GgmSrwWYFgJPJsA5ZGEZlGUBC03sEuxwqUVIKyOdaASJzojvhXIu5B6afZAPsCiILAI6qp04yLWL/BAVHwjaIxlPtMF93zIsIP6QOUZzflPALCyjjNSCQhG2DyQBQRTVCrE1819WY0Ai9NIk4CLxVR+8yHvuDJBxENX49Gn1+PRsPXl8kxyOClEoTXuIQDHFNG4zTG49eGyRMiVJyzVc81gpjQxpmt8LItsmyAFVUGwAdp2aEXktkAp0mwGwEalqSA4fjimfNF69q1Il3vJ40dWDUlQpCFtgIKYtnNBu08qXF1nPScOUn/DSTeuoTW+GGfCj+NiPhaG/JXeAOKfmhAw+cEBNW4t7LUutmedrVEh9e9TKYCqbzSsJnBRhDrU3QtiVREdQwgUsbytQjgASKe6HEO0sZSEXEoBJ7sD6A0Pf0iG+BZGkUeZznILa5Mh0gUMB6IoIS1AWpYjNEAx+Sz/f02G+CISOVJAOZR5vk8gIPIxUSBlWzmidXQZf4okUmjlIDwgSkyB9mESUKU9gfxGE8mwfJNNpkMN35U2Ortt8O3b4dv3zahux7J4zNPCTKbUb9DWEYjzRZQUbZ1Kk3pnFohyaF6O3RxDul5m4t9kHTO6ZfFIz2d0bISrZG6sutvw/ompBKtbbsOAJS6amwYVZ7tv+8uvtvDKOa5G+Y6RiJ1kISnAllX/JR8URPF/Wx48/J2hzacmn85IrwL/cvdGVU3unlZ7rbNsOLEJ4LGRCy8GJSo+DE7iuqcr4Jt2wf8btRLqG9oDDpQ+T3n9ztLNol5ypSJgGowU5hxAYigKef3Ol4ZEommAAzFJDD02lBRDWDN3DQ0T3GP+CGFByj2MzCbaTI19Weai25xwiVV9MFYV5iT/GfK7hl/ZPhux0UvuMiTSrRjvcyMVpM+iaAPH4BPZZXCLI2n1ZZ6/R5IlIIneSp88HLmWLSjgrMVGy20ClDQgfuJZbwy86dUzZqzTmkek1T4IZGwkxRdIY0WmnGBlCC+lRr+iGLCFqiAKBERYGQIcYb0m9yclmL+R7CqzmI9d4vlIuWOL04ZKd9tHRWZHxBW3+7ErHT1Oib7EyfRK5x7PorMWzvqBvsr+mrnJj0vF37IIz6nPonGNyKVLih07jL2ZLtPxxfPmi+OqHu15mpRp1VdqP/dkPmrCkb5w9qzynMg8d+ttA/Lvhnsi+wbf2QH5XJb7YrL8b5YOcxXacsSbnDTO81E5qkNxPSSul9N07rA4YMdob0dkYjbrd/4P0CCqpE6r7BqieR2GQptdqg6sOvfKvhOK7xgrVBjnLXoH2gIOziniPDW9ceh5jAXAGsQa89xLcrcGZZ7o+OMJA0oML8xwlXO5y8n2IYUJ3i8JCwYTya3d1mGSyB0sJRWorQtDB8uEq5CkLThJIENlAbUb46i6SHNKy/htHqeYd2C6uE0uxlF6QWgCI2am2o8GiKl2YqDdW/wlZZCrxaJbjyJcPAOuxLf25tXy2eR1pz1w+qpZsrSSKeMkVIudwqPvksFou+udaDT7bHPXVu7+Kbji0P22N0poN3WsddRzyaFerVWptUNQ+kFrgywldNLerlXmwcQctuBz9pJthJmjcibFg3nBXe0Pz5nM9qxl+lDjp2PxP4OAfo+VcpSu3Qcczt7V49fNhLofzmczJwz9DkL1t7Wia10D4ZxZwu2g3VnC9zZAne2wJ0tcD6W870dX7izBe5sgZOxp5cxd7bA8YU7W+DOFjg5fJ5y6M4WuLMFe5DenS04b63wRZ4taEWtMVp+XUTICyA2RvlA4fHpg+XAHqjgzLQpwsdFuLd0x4UdPkjtSYS7ou7P1wHqRr5suDNgRoW9n4PLVMBBis5cCXEUSPoaMc9PFZ/NjqJ694fRyDvvLZ+Ueabp+gqXaHGJFpdocYkWl2hxQZ1n7za6RIvjC5docYkWJ2MvR/e6RMtZ84VLtLhEi5PDp5dDl2hxiZY9SO8SLeetFVyi5YiJi9YiiPK902eS4TCx16YI7bo5+DS2JiDWEt2zrSWk3xt2ssJky0TqvWcRJ/Ye9zghfhsROvt6EX+0mm5vCGmS7AehrYimnOHpEOamVM1KsLptyJGyPs5gPH+D0WHz68y4NiglDujyB4+Vgq6MeEJHUyri34+nxL8HFrhY1/kLgYt1Ob44ZTH13uXRJfu9Gf2qvKqrxx10+gYknfzlCk6wwxeQRAtP8SairVZPvxi0DrAmlNle1ObzG1dQHs7T0+kXl9zAo0LVg2wXWV3NUuw9rADgwcYmxHznx3xrsfgFAbUveIJXX8wxHzSM8z65mjAnP4rfd85snbd6culxxxcnTtFovdmEQq1hW6ikDhUevf7ffOtS9t0j9LbSK3tR6rtBgh4mW1ufbZbaWqY6hs7eOnvr9Orz1qvO3jq+cPb2hdrbGXngguo1OcIXjp1APmuB7ApqH8nD2J14G4j+mPNkSbZ0ExKBOKRm58TTtk9KbpXm6jTxGEAAAS5dbhtTGRPlh9qXMivsSfoneAKIH5qW+VPz3eV1630dqWMY3RgU0YVePZRw84WAeu3sbXfrGbcow9OWXT0VFQX8kVIBgbdBhJqS2MyMl4tnRv968/ZbA8ywyzE/XL0GuQeG7cCb6zpNi2s9xtp2e9IXwGTIj1Of16saqc1tWF9ybeq6BFjkKqamc4xvzYGEKXRYpDyjjf79lUT2Wki0/v56T1VVwmt/nWiBSDI/+sdgjfjxJOnrAwgwytFcvB0T1rdcb02EXomFH2kEH0zzqsdknhsyVIiyVbM80kCFHbww+qcu6AuBzsMOjvvO3Ktuht0iiMXr7qK03EH6xEPmBRxWng5nqnwAaDsAGpM5DPNuUyJhm4O1Ug36fb7cXgSz8mRbjoqY5jrE0L/1JtW72tdo39rBhS7O2SPuG7rIyXngLsmt9hOfAi07GZ1eRpOJzU309ap/g8Gwxrf10Nq6f/X0ZnnP02/b0XhOtOtwaT1VXhRWdFSfdDF4j7qQ4/oTrvDaKZBnaC5cpPsL4gtXeO0Kr52MPVPd6w6jnjVfnFvhdXWUHYpTunW9q3c+P/Y/Vb3zvrbb3UhX6+9upHM30vW6ka7hwgx3n8BJKe/uE3BWd99I8pd2n0DjfSfHu9DnYI+kJ+GcY+McG+fY/L2Ojcv4uKjjCzX0LuPj+MJlfFzGx8nYy9G9LuNz1nxxbhmfkyhtd9Wuk8PT62d31a4LjbvQuNMKxwmNbwp+bpYa77Y9Tay7eJJluaYKeaDjo2CYjOgiEzw0sxgu9X8/B5ku1wTxYETidmlqXsY4VCqR4+FQEhZM+edLMpUxESpaXPo8xtmd7uOnguq44u3SEO4qob+A/vOu/PraDyG2XF1utKagfTDAlOlhrU7aCIXhK6T7oqv3P6NfYGHiXvo3SVXIBf3T6LNLdHHxayoVmgKiDKkQkF1pNMFXCf1Gd1zw1BZAeCSh3j0sJvjiAhdhOnxVhqfJYnDHY/z/HMBkIieT63+YFaVsZm5fKShf3Ck5wJqUFu/Xl6PLUX02DL1LgOkZXCfg01kejEMqJArZtlOQZgpX3+d0NxPWE3/kwsT7HqkKzYRQ6Qo6lAg+FySOidL7zGhxiW2FlL05V9fwUR+YtJWrdtbvBU8EBUXEwn5jkEsV2yuA8xaaqdBPP9xszmRZFF/hMb64+D2vDUXvQcRUahLIi4sx+mi7g/qIuMj/ugpiyj7ildJW8FkNk4hQUySYqyTLrre50A3w2DIsvhvgkEulXy2Xuo7rg4iyTD/+IwVhODAvkzCq73aJAyr17yDXmS3T+LqYxSukUxU0MGmKEJBB2yzQgqfokcpQ5z/moJCuKkYzwePLbfMpWJ1pPs9vQMZ4gO+1JOB8Vtmdqakz/K9xti+vfB8SVepWCt4OP0ldVHlXknO9SFn2F3bFX68= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Team GET

- - - - - -**Required Permissions**: `Team Get` or `Team Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a team's data. - -
Schema
    team object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • ]
  • ]
  • ]
  • metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/teams-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/teams-list.api.mdx deleted file mode 100644 index 46cd392d..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/teams-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: teams-list -title: "Teams LIST" -description: "**Required Permissions**: `Team List` or `Team Admin`" -sidebar_label: "Teams LIST" -hide_title: true -hide_table_of_contents: true -api: eJztHV1z47bxr2DwksZVLN05nbR6czpJmuYuvol9fbFcHkSuRJxJgAeAthWN/nsHACmRIkVSX7WtQ2ZuIpPAYrHYL+xiwTkOQPqCJopyhof47OwP+JJSAQH6ACKmUlLO5NnZEH26ARKjd1SqT4iL7M/LIKbsE+7hhAgSgwIh8fB2jhmJAQ+x5ELhHqYa8pcUxAz31sa7CQHx8WfwFbqHGVIc6T5IhYAEyDRSEo1n57iHpR9CTPBwjtUsMbCVoGyKexieSJxE+pEZdbHolcb3iPTXcagAG3MeAWFFaEqkUISVkCm0wqFMwRREEc6bIhCqIJa7QPnbYnHXwwJkwpkEqRu/HQz0/8r0vET/vr76HV1ZkvqcKUIZZVNEGCJCkBniE0SiCCkgsdSE1W2AKQ2KJElEfaJB9T9LDW9eRc6ull5ywRMQilps7Myqc1j0LOXqZhdTRuM01jTqYcUVieoBGFwLr8xENBXXxtyEWlAPFp4UCEYizzZgaRSRcb70vZoOdhGbOPA9Efeg9NNFD/sCiILAI6qu04SLWL/BAVHwnaKadVd9xrP2eRHhh/QBgmY+npBIwqKHyQNRRNRBLU982dSb0Ai8NIk4CbxURM0z7/uCJx9F1H8zGDy9GQz6b86TQ5DBSyUIr3YJ1xgogIQIFWe83HGNICa0dmZLvGyLhWZDqgyAj9KyQyckFz2cJsF2BKhZkhyG44sXzheNa9eIdLWfNOZ0V7XXzJMaV8dJL5mTMsO3cQn1SzzEPhV+GhHxF+2QfYvXoOiHBjQ8JSCoxr2RpVbNdrSrJc+ni8lUIJVXGHZhsBHEOjRtSyIVUS0DiJSxbC0CeICIJ3qcvbSxVETsC4EnuwMoTE+/WPTwJI0ij7MM5AZXpkUkchgPRFDCmgDVLMagh2PyZH9fLHo4IlJ5EoB5lHk+D2AvcjGRY1XnYxaHLvJHgUwapQSED0yRKcg6TBKitD+Ih3g0CuZvF6NRf+1Hia0uvu9fXPQvLurQXY3k8YmnBJlMqN8iLIOBZgsoKdsqlcZ0Sq2QZFC9Lbo4h/S0zcUuSDrn9OvikY7OaFGJVkhdCjk0YX0TUolWtv0biYpdNTaMKs/233UX3+5h5PPcDnNANJA6WsJTgawrfky+qIjibja8fnnbQxtOzb8eEd6G/sXujKob3bwod5tmWHLiE0FjImZeDEqU/JgtRXXKl8G2zQP+MOgk1Dc0Bh0u/pHz+60lm8Q8ZUoLt154NIYJF4AIGnN+r4OlIZFoDMBQTAJDrzUVVQPWzE1D8xT3iB9SeIB8PwOTiSZTXX+muegWJ1xSRR+MdYUpyX6m7J7xR4bvtlz0nIs8qUQz1vOF0WrSJ1F9iHaND8Cnskxhlsbjcku9fg8kSsGTPBU+eBlzzJpRMZHirKVWAQpacD+yjJdm/pyqWXPWMc1jkgo/JBK2kqJLpNFCEy6QEsS3UsMfUUzYDOUQJSICjAwhzpB+k5nTQqLhAFbVWayXbrFcpNzxxTEj5dutoyLTPcLqm52Ypa5exWR/4ST6FmeejyLTxo66we6Kvty5Ts/LmR/yiE+pT6LhjUilCwqduow92+7T8cWL5osD6l6tuRrUaVkX6n83ZPptCaPsYeVZ6fl+R0B2Utr7Zd8M9nn2jT+yvXK5jXbF5XhfrRxmq7RhCde46UozkXlqAzGdpO69aVoVOLy3I7SzIxJxu/Ub/gtIUDZSpxVWLZDcLkOuzfZVB3b9GwXfaYVXrBUqjLMS/T0NYQvn5BHeqv7Y1xxmAmANYuU5rkSZW8Nyb3WckaQBBebXRriK+fz5CNuQ4ggP54QFw9Ho9m6xwAUQOlhKS1HaBoYPZwlXIUhac5LABkoD6tdH0fSQ5pWXcFo+z7BqQfVwmt2MovQCUIRG9U01HjWR0sWSg3Vv8JWWQq8Sia49ibD3DrsU39uZV4tnkVac9dPyqWbKwkjHjJFSLrcKj16lAtGrax3odHvsU9fWLr7p+GKfPXZ7Cmi7dex01LNOoV6ulGl5w1B4gUsDbOT0gl7u1OYBhNx04LNykq2AWS3ypkXNecEt7Y/P2YS27GW6kGPrI7F/QIB+TJWy1C4cx9zM3uXjl7UE+k8GZ2HOGfqcBStv68hWugPDuLMFm8G6swXubIE7W+DOFjgfy/neji/c2QJ3tsDJ2PPLmDtb4PjCnS1wZwucHL5MOXRnC9zZgh1I784WnLZW+CrPFjSiVhstv84j5DkQG6N8oPD4/MFyYA9UcGba5OHjPNxbuOPCDh+k9iTCXV735+sAdS1f1twZMKHC3s/BZSpgL0VnroQ4CKSAKOL5qeKTyUFU7+4wannng+WTIs/UXV/hEi0u0eISLS7R4hItLqjz4t1Gl2hxfOESLS7R4mTs9ehel2g5ab5wiRaXaHFy+Pxy6BItLtGyA+ldouW0tYJLtBwwcdFYBFG8d/pEMhwm9loXoV01B5/G1gTEWqI7trWE9DvDTpaYbJhItfck4sTe4x4nxG8iQmtfL+KPVtPtDCFNkt0gNBXRFDM8LcJcl6pZCla7DTlQ1scZjJdvMFpsfpUZVwalwAFt/uChUtClEY/oaEpF/PvhmPj3wAIX6zp9IXCxLscXxyym3rk8umC/16NfpVdV9biFTl+DpJO/XMERdvgCkmjmKV5HtOXq6Re9xgFWhDLbi8p8fucKisN5ejrd4pJreJSoupftIsurWfK9hxUA3FvbhJjv/GDz3cXsFwTUvuAJXn4xx3xFMc76ZGrCnPzIf985s3Xa6smlxx1fHDlFo/VmHQqVhk2hkipUePS6f/OtTdm3j9DZSi/tRaHvGgk6mGxtfTZZamuZqhg6e+vsrdOrL1uvOnvr+MLZ21dqbyfkgQuq1+QAXzh2AvmiBbItqH0gD2N74q0h+nPGkwXZ0k1IBGKfmp0jT9s+KbhVmqvTxGMAAQS4cLltTGVMlB9qX8qssCfpn+AJIH5oWmZPzXeXV613daQOYXRjUEQXenVQwvUXAuq1s7fdrWbcoAyPW3b1XFQU8CWlAgJvjQgVJbGeGS8Wzwz+8fbiewPMsMshP1y9ArkDhs3A6+s6TYtrPcbKdnvSF8BkyA9Tn9epGqnJbVhdcm3qugRY5EqmpnWM782BhDG0WKQso43++Y1E9lpItPr+ekdVVcBrd51ogUgyPfjHYI348STp6gMIMMrRXLwdE9a1XG9FhE6JhZ9pBB9N87LHZJ4bMpSIslGzPNJAhS28MPi7LugLgU7DFo77wdyrbobdIIj56/aitMxB+sxD5gUclp4OZ6p4AGgzABqTKfSzbmMiYZODtVQN+n223F4Ek+JkG46KmOY6xNC99TrV29pXaN/YwYUuTtkj7hq6yMi55y7JrfYznwItOhmtXkadic1M9PWyf43BsMa38dDaqn/59GZxz9Nt21F7TrTtcGk1VZ4XVrRUn7QxeIe6kMP6E67w2imQF2guXKT7K+ILV3jtCq+djL1Q3esOo540X5xa4XV5lC2KU9p1vat3Pj32P1a98662291IV+nvbqRzN9J1upGu5sIMd5/AUSnv7hNwVnfXSPLXdp9A7X0nh7vQZ2+PpCPhnGPjHBvn2Px/HRuX8XFRx1dq6F3Gx/GFy/i4jI+Tsdeje13G56T54tQyPkdR2u6qXSeHx9fP7qpdFxp3oXGnFQ4TGl8X/Mws1d5te5xYd/7E/GdUVcgDHSAFw2VEV5ngvp1GD0sQD0YUbuem1mWIQ6USOez3JWHBmD+dk7GMiVDR7NznMV7c6T5+KqiOJ97ODcEuE/ob6D/viq+v/RBiy83FRivK2Qc9TJke1uqitRAYvkS6L7r88Cv6DWYm3qV/k1SFXNA/jR47R2dn71Op0BgQZUiFgOwKoxG+TOh3uuOMp7bwwSMJ9e5hNsJnZzgPz+HLIjxNFoM7HuL/ZgBGIzkaXf/VrCRlE3PrSk7x/C7JHtaktHi/OR+cD6qzYegqAaZncJ2ATydZEA6pkChk245Bmilc/pjR3UxYT/yRCxPne6QqNBNChavnUCL4VJA4JkrvL6PZObaVUfbGXF27R31g0las2ll/EDwRFBQRM/ttQS5VbK/+zVpoZpLo3a/XN+tzmedlV3iIz87+yKpC0QcQMZWaCPLsbIg+aQDoHZXqE+Ii+/MyiCn7hJf6WsGT6icRoaY+MNNGllFvM3m76+GQS6UfzOe6cOujiBYL/fhLCsJyYkCl1nRBphYb8NUpCKsh0T3MdBZDcqEM1QXINFISjQ39ahG811yMdQ+8vFdZB8NrMFg19Yj0OzZPdKlet6ZW6RTb3mXlIUbl396ZIj0jWJpCttOl70NSxL0QDe5/lrpK866gN3756QYvFv8DoWbojw== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Teams LIST

- - - - - -**Required Permissions**: `Team List` or `Team Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all teams. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    teams object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • goals object[]
  • Array [
  • goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • metrics object[]
  • Array [
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • ]
  • ]
  • ]
  • metrics object[]
  • Array [
  • metric object
    goal object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
    tags object[]
  • Array [
  • goal_tag object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    updated_by objectnullable
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • teams object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • tags object[]
  • Array [
  • ]
  • owners object[]
  • Array [
  • user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/unit-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/unit-get.api.mdx deleted file mode 100644 index a565e461..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/unit-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: unit-get -title: "Unit GET" -description: "**Required Permissions**: `UnitType Get` or `UnitType Admin`" -sidebar_label: "Unit GET" -hide_title: true -hide_table_of_contents: true -api: eJy1VsFy4zYM/RUOLt26WtvpUTd3prOz3dkm0ySnOHVgCbawkUguCSVRPfr3DknZURInu22nvtgSgQc8AHzwDkryhWMrbDTkMJn8QV9bdlSqM3INe89G+8kkVzeXmuWis6Q+kNwo40ZvFmXD+gYysOiwISHnIb/agcaGIId2sPtYQgYcwliUCjJwQyzIxbWUgS8qahDyHUhngydroS056LNneV5UpLhUZqOkIhUSUVKhqM606p59pcSoLYkqUVBtnGmm0F+HgN4a7cmHGD/P5+HrKfBC/XZ++rs6XX+hQlRhtCBr1luFKtD4wUfIKWQQzkhLgEBray4wQMy++ICze8nFRMhQJGcsOeGURUBdJZNvmXJ5vDSpzIcTL471FjKgB2xsHTvgya24fFHHt3xSiX2osWmdChA+ABSOUKhcoRzz3xjXhBMoUei9cENjn3W32qdylElryxG2busa1yGZNB7fF2uP8TTWK1ij2I85frsT6IqK72jMYm1MTajHJdxg7anPAO9Q0B1DfZrVwXS14ZpWra0NlqvW1W83alY4Yy9dPTuZzx9O5vPZydTq7f/aqgwa1ty0DeQncaYsOmmG2/B6pp/R3ZJwSo4a5KPMDnkli77PQFgiwKVPvfon9R+7D0IEffpk0JBUpoQcthS7HHQph9nhUvrZ7lG9esjAk7vby1vsDFQi1uezmUddrs3DFNe+QSd1Ny1ME1XHU9E6li46BQoLy58oPF6Pj8+DYqT5GhsdGGJ6MUhoRVjGTjzXr+CrFmcf1Sfq1Mak39hKZRz/FTVqqiaTz60XtSbFOipoqrlawsLy++DYmdalAUDLq1vqljCZwF5rYDHGg0G5w8GfA8By6ZfL859i91hvTOQxtGGNxS3psAxCKVPeJ9P5dP6SjVanlnRgcG6p4M2gsknsk+2afKSw+GWoeyQciN8bdxuk+56lioQUPVhyHAbVK+vM1mHToHCBdd3tNR2LMMV9BjUXpH1U1oH1mTPWMQm6LhKzxkuDemQRN9GHXy+eM9k9rov/umOHaRB6kJmtkXUUvSQSaX6vHpeKhwzy0f69zqAyXoLNbrdGT5eu7vvw+mtLLo5kBnfoOKnS1Q5K9uF3OVynN3i929P6Uf2L9fwKsf3s6zD4d1i34QkyuA1XY/zPor/us/2lCHkng0VRkJWR64tVHW7gQQVC5/r+b7JSIcs= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Unit GET

- - - - - -**Required Permissions**: `UnitType Get` or `UnitType Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a unit's data. - -
Schema
    unit_type object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/units-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/units-list.api.mdx deleted file mode 100644 index bac30e7a..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/units-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: units-list -title: "Units LIST" -description: "**Required Permissions**: `UnitType List` or `UnitType Admin`" -sidebar_label: "Units LIST" -hide_title: true -hide_table_of_contents: true -api: eJy1VlFz2zYM/is8Pnqq7exuL37z7na7ru2SW5Kn2HMgCbZQSyRLQmk0n/77DqIcK7aTpt3NL7Io4MOHDyDInc4xZJ4ckzV6pkejv/BLTR5zdYW+ohDImjAazdT9rSG+aRyqjxT4Xlk/WJrnFZl7nWgHHipk9EHP7nbaQIV6poP1rBNNEuFLjb7RyVHcmwKVTT9jxmqLjWKrxEdxgcpjqEsOKm3GOtEhK7ACPdtpblyHzZ7MRicaH6FypSx1Uds2eRZ/BSE75nACllpbIpghGvsah1gONvhNHDKMG/RDnIshCDFW4UdQfmnbZaI9BmdNwCDGP0+n8niu51z9cX35p7qMkmbWMJAhs1FgFHgPjbJrBWWpakMcRFixQcMCBc6VlIFATT4HwdudkovVkpJ769AzRTYxs9Mc2iQqdy67igxVdSUaJZotQ3keQLiuZHkYoMtGpDwK/BK//Dx2LMxrXVUH9CvKxfiZ1q/5SFtTHkRsW3slEEEAMo/AmK+Az/mvra/ki86B8R2TdPPBJ21WeyrnVXL5ANvUZQnpvpGTN8baYzyP9QLWIPaB47crAT4r6AHz17ffGsqAbaLhARj8OdTnrJ5MV2sqcVW70kK+qn35eqEmmbfu1peTi+n08WI6nVyMndn8r6U66vscHXiu+i34MtNP4LfIFMlhBXQ2syde0aKVjUXcAdyGWKvv0X/o3s983fa/RFfIhc31TG+wKzNwIZIOtmuiA/qH/anQVUMXzC7MJpMAJk/t4xjSUIHnshlnttIy5gJmtSduOiehPXf0AeV1Ofx8LaMp9tTQ6DAh4kI/bQuEvFP/eGCKr5pfvVcfsFFrG/9DzYX19E83DMdqNPpUB1YpKjLd4RR1Vgs9d/ROHBtb+1h0cLTaYrPQo5Hezxc9H+LtZ758+LsHWCzCYnH9U1cxMmvb5dFLn0K2RZPrRIuUkffFeDqenmZj1KVDIxlcO8xo3Y9zxQWwirYphi6F+a+97l3CkvhX67dyVnwlLrqEFD469CTNGZTzduOhqoApg7Js9ocHZNK5baJLytCEbpr2WV956zwhg2+6xJwNXIEZWEhXBfXx/fXNcS67w8n0n28nfUMwPvLElUCmm3VxNsSuvRseMstEFzawrO52KQS89WXbynI8sqUtcwoyfPJ+p7xC/s1XnLMst9LS+4vUA5S1mGi5UpwwOJj2d563mPfXmreY7i8vB9ulvHiKU/hu2Sb7XSYKRad5lqEbcj+5ZAjK0yT5/bcb3bb/AqAoo40= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Units LIST

- - - - - -**Required Permissions**: `UnitType List` or `UnitType Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all units. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    unit_types object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-add.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/usage-alert-add.api.mdx deleted file mode 100644 index c8bc391f..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-add.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: usage-alert-add -title: "Usage Alert CREATE" -description: "Usage Alert CREATE" -sidebar_label: "Usage Alert CREATE" -hide_title: true -hide_table_of_contents: true -api: eJztVktv4zYQ/ivCHFPFdoq9VDdn4cNisUiQx8l2jZE0sbimSIYcOVEN//diKNnxaxftXltfTNPDeXzz8RtuwDryyMqaLyVk8BxwSWNNnsdlCSl4Cs6aQAGyDfw+GslXSaHwyskZyOBuBSkU1jAZln/ROa2K6HH4PYjJBkJRUY2ycl7iseocegqN5vN9MphrKmXJrSPIILdWExrYpsCVp1BZXS5cwQcmpqlz8pDCi/U1MmRQ2ibXJGdeG8u46Az3BwJ7ZZaQApmmhmwKtTVc6XZBazIcIIWW0Mvvd0de1f3mzgoLVmtaNEZxgHkKrFiL21ultTLLb8ReFRK88IRM5QL5UvCPbJHpmlUdE1blP6psKx16bZQXsKZ73E5BOgLgKKEYSZLvItn8OxUsCdjVJfRP4vX9i9bnTrZi/ukSZ36dMeS99XGlmOpwDuh2nwZ6j+0PS9l3/QV1oHkKptFa0IMs7pxB2wW+XOpH8ydi9tBfmj0En/6H4I//NgSSEC6D+Jh06jJPIVDReMUtZNN5Cg491sQkhclviUuBb23Zdlq5S4N9Q78MXRPIL1R5EbyfKegpnP9ehU+g3Cdy6usHQnLMnTinkjioks8Pk/HTRJSZuLIyxZwN0g6HXEEGw/XNsJP0YbMfbxI3kF93cG+g8RoyqJhdyIbDgKbM7fsA81CjZ90OClvD9qBnj4JvB+lzID926iu1Bzhgt5GCknQrwjKiclzFOJGzyfj+S/KV2uTFdmtsuLJe/RU7Okiurr41gZOcEmUSrijpoE1mMHbqWg62tvGLCCg6tVhRO4OrK0jBYC25jA/9Sd0xd8jgz97BbBZms8ffYo+EQA8f1Ju8Y+00HVNnOpqfMWAkU8u82IhBfw9yLFZkZB4Jzl3NN4PRYHSOhEnuHBmp/tFRoV56PidcISedbU4hlj++7ZsSwRLQ3qxfKbNM3hRXEYzkYGQnztulx7pGVgVq3Q564cFI3G0KWhUkFzXb7BC799Z5RYy+jaAIoWo0BxYXCXhU054KTO88dBpVfL5Eom16bk5hfSMitHtwHPJznkIlPM6msNnkGOjZ6+1Wtl8b8r1orNGrTq+m822645kQeiV0hM+dSlw/dZN/jbrp2HmiGNt0d2JcFOT4p7bzg6t2f/f4BCnkvUrVtpQzHt/k8YhvkMEMZiL1NsLSPftkfwMazbLBpdh3fuXzN7dupK4= -sidebar_class_name: "post api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Usage Alert CREATE

- - - - - -Usage Alert CREATE - -## Request - -

Body

required
- -Ok - -
Schema
    result objectrequired
Schema
Schema
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-delete.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/usage-alert-delete.api.mdx deleted file mode 100644 index 0d85674d..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-delete.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: usage-alert-delete -title: "Usage Alert DELETE" -description: "Usage Alert DELETE" -sidebar_label: "Usage Alert DELETE" -hide_title: true -hide_table_of_contents: true -api: eJydVMGO2zgM/RWBp92pN8kUPfmWRXMo2qJFp3NK0gFtM7EaW1IpOh3X8L8vaDupOzOnvSSyRFLvke+pAx+IUax37wpI4T7ikdYVsbylioQgAaYYvIsUIe3g9WqlfwXFnG3QNEjh0wkSyL0TcqKnGEJl86Ho8nvUkA5iXlKNugqsV4odC/qT/kobCFLIvK8IHfS9XvujsUwFpFsN2ieXIJ99p1yg7zXqzerNczz/Hw0xex5WVqiOM2hR2Loj9FcYyIytfr/IIAFyTQ3p9oBVpH0CrqkqzCqCdNh5ynC6OHmRagJiRVNho2FfpoEMLVBAeIxaY3MmJ1HTI+UNW2kh3e4TCMhYk5AS23ZgtUUBpYQEHNZa1hYwhyPcUDLr0cFzjQIpFL5RCld8rqkzYuj7ffJkBIOOzCAk83bzYfN1AwnUJKVXlRUXbQ0wUlieb5c0oF82VwHGZWeLHpQNny/gG64ghVIkxHS5jOiKzD8uMIs1slTtIvc19LMO3CmJcbb3kXgd7HtqZ/PCcSMZu1ISFsTwlMzaaK5Zf35n3lNrDn5cYyOlZ/trkNbC3Nx8bKKYjIx1RkoyY9vMDtbB/qOJrW/4oYnEDxjsw4naHdzc/J7Cel4PpgHowbepwG4Xd7u7V4M9rDv4gcekjAzzEzmdo/ZqxH27WC1Wz9k48ymQUwZ3gXJ7mMxhpEQxY2xGcaCw/ndq7EBYif/0fLLuaH5aKQdChh4Dsa11eiawPzLWNYrNsaraxWRFzNWKfQKVzUmlm3YX1p/ZB7YkyO1ALPgoNbpZxIta+oPTdZxCj7IMFVqnzhzE0k0i28L5Vm05miSBmdAggdQWapzSR9HQrssw0j1Xfa/bPxriyUxnZDv6eNtBYaOui8nUz1BdXyH468vkrr/Nb/v8ifaiSKdyPGPV0PiUnVSwatF+3ycXiert48E6zynILOXZe6d+uFpvamDf/wejPwkK -sidebar_class_name: "delete api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Usage Alert DELETE

- - - - - -Usage Alert DELETE - -## Request - -

Path Parameters

- -Ok - -
Schema
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-get-all.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/usage-alert-get-all.api.mdx deleted file mode 100644 index ec35960a..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-get-all.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: usage-alert-get-all -title: "Usage Alert LIST" -description: "Usage Alert LIST" -sidebar_label: "Usage Alert LIST" -hide_title: true -hide_table_of_contents: true -api: eJydlFFP2zAQx7+KdY9d1pY95i2TEEJsAqnwRFl1Sa+NqWMb+1LIqnz36ZzStYAmtLzEds7n/9/3u+zAeQrI2tnLJeRwF3FNhaHAF8SFMZBBoOidjRQh38G36VReS4pV0F62QQ7XG8igcpbJsnxF742uUtLJY5SQHcSqpgZl5IMcyXpIiHJWGmmmJr4PqJxd6fWijRT+FSbfF3opQ+48QQ62bUoKkMHKhQYZcli6tjQEfS+mnlodaAn5/WHrQ/a61ZWPVDH0hwUMATuZk8XS0PExpXOG0KbgOlCsnVkufMWfUpLB/0k+uZS/qt5KSOk/Y8ttPnL05tB9qVL0+6TyZMC4jhJ7viXLUcIiVW3Q3EF+/5CBx4ANcaqlzE9BSvSphJ/6cTm7hQwa4toJmWsSPx65hhwm27MJpSMm7YFYkRYpbIfkO2iDgRxqZh/zySSiXZbuZYxlbDCw6caVa6A/UjgTRAea7iKFwusr6o7uBYeFDLRorQmXqVanFgole1Vxc6muqFMrN4yx5doF/Ts1xViNRj/byKokpa3imtRQcDWHwuuvsrFzbUj1XaDXiw11cxiNIAOLjWgpjvOJ76Qdcvi1TzCfx/l89iUVUduVSz40m1RgrDZkBRe5q0H32Xg6nr53Y9W1JysOZp4qvdq3teIaWQ2xJcVkofi+v9hkWIw/u7DRdq2eNdfJkKIXT0E3Ujjlg1sHbBpkXaEx3Xj/E8HUO30GRldkI4nyveub4HzQxBi6ZMy7yA3ao4gPCDpxdCgm0wtPvEGdOjehstvTdQ/bM2mqAeEMjgl7yKB2kSVotysx0l0wfS/LTy2FPeRbDFoaUmZ99kqKILkRoKCoKvJC8xZNO5D15ocpWB7Ivzi/hb7/A9+Q8UA= -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Usage Alert LIST

- - - - - -Usage Alert LIST - -## Request - -
- -Ok - -
Schema
    alerts object[]required
  • Array [
  • config_users object[]required
  • Array [
  • ]
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-patch.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/usage-alert-patch.api.mdx deleted file mode 100644 index 26a716ce..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-patch.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: usage-alert-patch -title: "Usage Alert PATCH" -description: "Usage Alert PATCH" -sidebar_label: "Usage Alert PATCH" -hide_title: true -hide_table_of_contents: true -api: eJztVk1v4zYQ/SvCnNpUsZ1iL9XNWQToYrHYINk92a4xkiYW1xSpkCMnqqH/XgwpO/7qolj01uYSmZovvvf4qC3YhhyysuZDCRl89biiqSbH98hFBSk48o01njxkW/h1MpF/JfnCqUayIIPPa0ihsIbJsLzFptGqCDXH37yEbMEXFdUoT42TjqxiQUe+1Xy+TgZzTaU8ctcQZJBbqwkN9Clw5chXVpfLpuCDENPWOTlI4cm6GhkyKG2ba5Kc59YyLmPgPsGzU2YFKZBpa8hmUFvDle6WtCHDHlLoCJ38fm3IqXpY3EVhwWpDy9Yo9rBIgRVrKXurtFZm9YnYqUKaF46QqVwiX2r+Ni0yXbOqw8Cq/Ec764Wh51Y5AWu2x+0UpCMAjgYKnWT42Mnm36hgGcCuL6F/0m/gL0SfF+kl/N0lzfy4Ysg568KTYqr9OaD9fgx0Dru/3cqe9SfUnhYpmFZrQQ+ysHIGbWx8eatv5N9J2MNwaPYQvPsfgt/+2xDIQLjyUuMuussiBU9F6xR3kM0WKTTosCYm2dhsC0ogapDFhQ3WUlaVcDgOu5bSA4xO3SE98Y++X8R08nxryy468HG1HySk9eSWqrxIyfd8+ZSkf9n4+8uedCzDcOkl4dZL7qdf3v8uHk9c2TISEO7BQEQG483NON4O43Z/V/rxVpU9CJ9us6OvdRoyqJgbn43HHk2Z29cR5r5Gx7obFbaG/kADj4JsBPOrJzdt1EfqDjaJcSGNuqgIy7Dl461ME8lNpvcfko/UJU82PmPLlXXqz8DlKLm6+tR6TnJKlEm4oiTilsxh2qhrSexs65aBU2zUck3dHK6u3nQ4PawHgwTlxR9Dgfncz+ePvwQCRDoPb6K7e8W60XQsmtlkccB9VOIJ2xO5FM2TDZAMxyzHYk1GDoXAHiG4GU1Gk3NgTPK5ISNgPDZUqKdB2AlXyEmMzckHNKa3A0cBO8Hwxbq1MqvkRXEVsEkOvgiSxtmVw7pGVgVq3Y0GX8Mg0j4FrQoSH8i2OwDvnW2cIkbXBYwa67lGcxBxSZRHW9oLg+mVx41GFc5IkN12kOsMNjdicbvPmQPJQgpZvPkr61lCt9scPX11uu9l+bklNxjTBp2KnjjbQqn8QFMwyLOp9gYCPz0M3vJz8mZFx9PutG1E2BvULcVrYS3SF7vrF326E7t0jy/exx7XX+LnzC7xzLD6dJcxLQpq+Luxi4NTv0M8H1yytqUkOXwRA8YXyGAOc5nUho3Hj1lZ34JGs2pxJfGxsPz9BTjt604= -sidebar_class_name: "patch api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Usage Alert PATCH

- - - - - -Usage Alert PATCH - -## Request - -

Path Parameters

Body

required
- -Ok - -
Schema
    result objectrequired
Schema
Schema
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-update.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/usage-alert-update.api.mdx deleted file mode 100644 index 4203d81f..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/usage-alert-update.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: usage-alert-update -title: "Usage Alert UPDATE" -description: "Usage Alert UPDATE" -sidebar_label: "Usage Alert UPDATE" -hide_title: true -hide_table_of_contents: true -api: eJztVk1v4zYQ/SvCnNpUsZ1iL9XNaXNYLBYbJOuT7RqUNLG4pkiGHDlRDf33YkjZkT+yKBa9tbmEpuaLbx7fcAfGohMkjf5YQgYzL9Y4VehoZktBCCk49NZojx6yHfw6mfC/En3hpGU3yODLBlIojCbUxF+FtUoWIej4m2eTHfiiwlrwyjpOSTIGdOgbRef7qEWusOQltRYhg9wYhUJDlwJVDn1lVLmyBQ1MdFPn6CCFJ+NqQZBBaZpcIfs8N4bEKhoeHDw5qdeQAuqmhmwOtdFUqXaFW9TkIYUWhePfrxadrPvNvZUoSG5x1WhJHpYpkCTFYW+lUlKvPyM5WXDywqEgLFeCLiV/q1YQXpOsQ8Gy/Ecn67hDz410DNb8gNspSEcAHBUUMnHxMZPJv2FBXIDZXEL/JF/fv2B9HqRj8w+XOPPjjEHnjAsrSVj7c0C7QxnCOdG+e5RD15+E8rhMQTdKMXqQhZ0zaGPiy0d9a/4dmz30l+YAwYf/Ifjtvw0BFyTWnmPcRXVZpuCxaJykFrL5MgUrnKiRkA8234FkiKygClLQouawsoRhOeQaTAcYnapDeqIfXbeM7ujp1pRtVODjaD/YkMajW8nyYku+p8unTfqXhf+ke4cq03eV8h0VOyZumJNJGJTJ7P6P6dc7HgtIleEpahumQuhcBuPtzTiOk3FzmK5+vJNlB0wAt933u3EKMqiIrM/GYy90mZvXkch9LRypdlSYGroBaR65FRH9mUc3tfITtgNURNxII5EqFGXA6Pgk04R9k+n9x+QTtsmTiWvRUGWc/Cs0f5RcXX1uPCU5JlInVGESgU4WMLXymh1b07hVgFdYudpgu4CrqzfiTofxoOcsf/izD7BY+MXi8ZfQMebawxtL715FbRUes2w+WQ7IEql7Qo8JT1H9ZAIk/b3MRbFBzV1n2CMEN6PJaHIOjE6+WNQMxqPFQj71NyGhSlASbXP0AY3pbd+jgB1j+GLcRup18iKpCtgkgydEYp1ZO1HXgmQhlGpHvRCKwOouBSULZOHIdnsA752xTiIJ1waMrPFUCz2wuMjJozMdmEH4SmOrhAy3KvBu1/N1Dtsbvh37B9CAs5BCFt8KlfHEprtdLjzOnOo63n5u0PVSthVORhWd76CUvu9TkNSzqg6SAz899Jf15+RNvI6r3ZNbM7O3QjUYB8mGuc8C2S27dM92zh4//B5zXH+ND6C945nEdeneY1oUaOm7tsvBpb+ffYUU8l5Va1OyixMvLNjiBTJYwILrNOHY8fHL+ztQQq8bsWb7GJb//gZPC/y8 -sidebar_class_name: "put api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Usage Alert UPDATE

- - - - - -Usage Alert UPDATE - -## Request - -

Path Parameters

Body

required
- -Ok - -
Schema
    result objectrequired
Schema
Schema
Schema
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/user-api-keys-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/user-api-keys-get.api.mdx deleted file mode 100644 index 960cc1e7..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/user-api-keys-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: user-api-keys-get -title: "User API keys GET" -description: "**Required Permissions**: `User Get` or `User Admin`" -sidebar_label: "User API keys GET" -hide_title: true -hide_table_of_contents: true -api: eJy1Vk1z2zYQ/SsYnBqVkeQeeVPbTCbtpPbE8cly5RW5EhGBAAIsbbMa/vfMAqRM25I79Ux1EUkAb/ftx1vsZYmh8MqRskbmcjL5gt8b5bEUF+hrFYKyJkwmubi9CujFR6RbYX3/tihrZW5lJh14qJHQB5lf76WBGmUum4D+UykzqRjaAVUyk77Hlzn5BjMZigprkPleUuv4lDKEW/Syy5759rVCoUphN4IqFNEBqoBEaxtxr0IlyIotUlxdXHwSf2IbhN1MZXfDZoOzJmBgS7/M5/z3FH4h/rg8/0ucr79hQaKwhkAZZbYCjADvoWXLoHXE3jF2tA4ehVZmhyXbB8GkpzKTDICG2A44p1UBbGf2LbCx/UvaNtrlWHrr0JNKrirCOhyPjoMtHlnJZK2Mqpta5mddJskS6OMA7OoKnFoxm9GWyJbT9sz2KRfL4/CpCg4rgbwyW5lJfIDaaf600Fr89uXq9yFdL3L+6mEzZELcK6piatxjzTLWDttjGBvrayAu0EaVMZKjY0f2OyBCzzVSeATCDEtFWYkaCTOPUPbBLFcQ820arWHNTqYSP2m/BML3pGpkgIQ9YPy3M+t2FZN5KhWNK0fYb/NvwHhq6wTWyPajj/9eSuCLSt3hmMXaWo1gxqnfgA7YZRLugMAfQ33q1WHraqM0rhqnLZSrxuvXC2xWeOuuvJ6dzecPZ/P57GzqzPZ/TdWz3i3Rgae6l5HTnn4Gv0NSyTmsQR1ldvAr7ehYHBRFABbTJx8WTsV+7H+ZrJEqW8pcbpFSS1QcIqYSZvuk9N3sICaZDOjvhnkQQy0rIhfy2SyAKdf2YQrrUIMn3U4LW0eRDlg0XlEbD7FPvRv59c14+ZK1MxXMeNOjfqUP/dypEMoY2udyn0ZYUh6xsekZGqqsV/9EtZ6KyeRzE0isUSgTB0sKolhyhN7zwdY2fjVW0qWcTOSgfnIxxpP9uOOFv3uA5TIsl5c/x+grs7GRR5+FNRQ7NDxBOZTJ77PpfDp/ycaIc4eGGVw6LNSmnzdpRqW9awxpNv7axz0SZuL31u940kUdZUICHxx6xZUXhPN266GugVQBWrfDdIOCy7LLpFYFmhC1vmd94a3zCgl8G4k5G6gGM9pxCH6cpB8/fH1Oaf84Qd96K+nLgfCBZk6DMlHGUtunAr6OM5DLNT9cVg41fJPJygbiXfv9GgJeed11/Pl7gz5WZSbvwKukNNd7WarAz2UvUa8w+mkg9E68+VpzguDQBIY74A50w2+yH4bDnay76bKhM9jztLgoCnQ0Ovbi5sJteJACzlrX/QADDYOA -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

User API keys GET

- - - - - -**Required Permissions**: `User Get` or `User Admin` - -## Request - -

Path Parameters

- -A JSON Object containing an array of all API keys that are linked to a user. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    user_api_keys object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/user-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/user-get.api.mdx deleted file mode 100644 index 806a8118..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/user-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: user-get -title: "User GET" -description: "**Required Permissions**: `User Get` or `User Admin`" -sidebar_label: "User GET" -hide_title: true -hide_table_of_contents: true -api: eJydVU2P4zYM/SsCL21Tbz569C0FimK72M6gs3OaTDO0zcTc2JJWojNJA//3grKTpjOzLbC5xLLIJz7qPfoEFcUysBd2FnKYTP6gLx0HqswthZZjZGfjZJKbp/tIwfxK8mRcGFfLqmX7BBl4DNiSUIiQP5zAYkuQQxcpvK8gA1Zoj1JDBmHEh1xCRxnEsqYWIT+BHL1msRXaUoA+e1Hbp5oMV8ZtjNRkUgFSo5ij68wzx9qIM1sSU6Gg2QTXTqF/1AOjdzZS1DN+ms/179/AS/Pb3c3v5qb4TKWY0llBtmy3Bo1S+C4myClkoHtkRSHQ+4ZLVIjZ56g4p9dcXILUBgXnKQgPVSjq/0dhKGvea6cukYVzDaGFDOiArW8I8g02kfoMcI+Cb6Larmmw0Fjt+CV0veGG1p1vHFbrLjRXqVEC2+31KTArg/P3oZkt5vPDYj6fLabebvWSykAoVK1R3kLYuNDqDlQo9E64peuc4rjWXqy5ekMAGbRsue1ayBdJDB6DtGP7v17pRww7Eh6Koxb5TWaXuoaIvs9AWBKAKgv64ZdBS1K7CnLYUroiVXEOMy07zk6DxHvIIFLYn/Wfugm1iI/5bBbRVoU7TLGILQZpjtPStUmakcousBxTkh679PyBdPl4vX2nsho0cR10IYXDi9FnNWGVuvdS5INlb9+bD3Q0Gzc8Yye1C/xXEvLUTCYfuyimIMM22Wzok1nB0vM7TTy6LgyXhp7XOzquYDJRlQ2eX17jwWhv3fhzBFit4mp192PqONuNSzzGzhdY7sjqxNBWDnUvpvPp/DUba248WWVw56nkzWjFYSIMsQXFRGH589j3RFiJP7uwU38/s9SJkKGDp8Aqrmh8cNuAbYvCJTbN8Wx8LFV5fQYNl2QjaeUj69vgfGASDMdEzLsoLdqriGF6/vLpJZPTPzPlW4fvqAKhg8x8g2xV+KOhB7k+pIkTIYN8nMmPGdQuim6dTgVGug9N3+vrLx2FpMAM9hh4GBwPJ6g46nM1Tpz/oPH9mcUP5htG9lf4nKVuVed7bDpdQQY7dcL5S9M/9tlZ/1rzsLksS/JylfZqdKvZLj7XS+r7vwGNSW4o -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

User GET

- - - - - -**Required Permissions**: `User Get` or `User Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a user's data. - -
Schema
    user object
    = 1`"} schema={{"type":"integer","minimum":1}}>
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/users-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/users-list.api.mdx deleted file mode 100644 index 6599d2a6..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/users-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: users-list -title: "Users LIST" -description: "**Required Permissions**: `User List` or `User Admin`" -sidebar_label: "Users LIST" -hide_title: true -hide_table_of_contents: true -api: eJydVU1z2zYQ/SsYHFVGH53pRTd1ptNJk9Seyj5ZqrwkVyIiEEAWS8eshv+9swRlK5bieOKLTGDxsO/t4u1BlxgLMoGNd3quR6N/8EtjCEt1jVSbGI13cTSaq/vbiKQ+msj3ytPwuShr4+51pgMQ1MhIUc/vDtpBjXquoyfWmTaC/KVBanX24r6bCpXPP2PBao+tYq/kjOIKFWFsLEeVt2Od6VhUWIOeHzS3ocdmMm6nM42PUAcrS/2tXZd9c/8GYvEyhzOw3HuL4E7RmBo8xQqwwx/iGMe4QzrFmZ2CGMY6/gzKb123zjRhDN5FjBL863QqP9/quVB/La/+VldJ0sI7BuOM2ylwCoigVX6rwFrVRKQowkoMOhYoCMGaAgRq8jkK3uE8uVQtKTn5gMQmZZOYnXPosqTcJXa1caZuatEo0+wZ7GWAPteTrZ6IqPjizu+kBlRU5gHL1+u9BRuxyzQ8AANdQnWNtZA/9cYxdLM1FjdNsB7KTUP29R6dFOTDLdnJbDp9nE2nk9k4uJ2wLAiBsdwAX0LYeqplR5fA+I6NdPrzmbzdiEgbU/5Y6BIDENdDzb+f6SegPbJJyWEN5iKzp7xSRCeVNNwDiEPobvjLdI1c+VLP9Q77GgFXokcqbqYj0sPRPnoVdcUc4nwyieDK3D+OIY81ENt2XPhay3uIWDRkuO0PyXWLYD6gfK5Pt5fSw6kXToOe+yktDM+yQih71V6+rOR41+/VB2zV1qf/oeHKk/mvfzVjNRp9aiKrHJVxvYslfdRKL4J5Jwdb31AqFgSz2WO70qORdFdyiMUp3tEcZOPfAWC1iqvV8pdeaeO2vucxKJ5DsUdX6kyLlCnv2Xg6np6zceoqoBMGy4CF2Q7vXnEFrFJsjrGnsPh90L0nLMS/etqLqXw1XPWEFD4GJCNNFVUgvyOoa2BTgLXt0WWgkI7rMm1NgS72njCwviYfyCADtT2x4CPX4E4iRPyoPr5f3rzkcni2sJ8eX0MjMD7yJFgwrred9JZTo94NLrTOdOUjy8LhkEPEW7JdJ8vJzqUTSxPFJ8rBVF7J983j72KCe+ni45B9ANtIiJZxc5bBc+gwD98SPoy8t4QeB9tz7Fo+yCTDvFt32fFhiULp0KIoMJzmfjaABOXJN/7840Z33f/wI/Z4 -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Users LIST

- - - - - -**Required Permissions**: `User List` or `User Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all users. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    users object[]
  • Array [
  • = 1`"} schema={{"type":"integer","minimum":1}}>
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/webhook-events-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/webhook-events-list.api.mdx deleted file mode 100644 index 3013b564..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/webhook-events-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: webhook-events-list -title: "Webhook Events LIST" -description: "**Required Permissions**: `Webhook List` or `Webhook Admin`" -sidebar_label: "Webhook Events LIST" -hide_title: true -hide_table_of_contents: true -api: eJylVU1z20YM/Ss7OKqs5HSmF97UTqaTJq09tTM9RK4MkpC4Efcju6BtVsP/nsGSimjJdT2tLhSXwFs84AHYQ0WxDNqzdhZymM3+oC+tDlSpKwpGx6idjbNZru7+pKJ2bqc+6Mh3yoXjybIy2t5BBh4DGmIKEfJPe7BoCHKILjBkoAX/S0uhg+zk1pualCs+U8lqR51ip8RHcU0qUGwbjqro5pBBLGsyCPkeuPMJm4O2W8iAHtH4Ro7SrX2fPbl/jbE8jeEMrHCuIbRTNA4tTbE8bulfcbRl2lKY4ryZgmgmE/8Lyo99f5tBoOidjRTF+IeLC3k8zedS/Xp9+bu6HFJaOsuorbZbhVZhCNgpt1HYNOphrCDdk+UoGRZjsiyY6H2jSxTMxecowPvzKIeySe2D8xRYD2ENFM/J9NmQwudoGm21aY0kKwN2jM3zAGPQ6yHoiU2iJnk9ufyfYqyexx+q9JLE3j56CtqQ5Z8DIVMlbk9K8KK3xK22ZCmIr3qoyUpl6BuqqgJuWOmoygF/LoIG1pwAxr5LONCPvwwMce0qyGFLiSxyDTksTtKVQaRwf2jRNjSQQ83sY75YRLRV4R7nWESDgZtuXjoDorlIZRs0d8npY6Sw9Po9yevt9PO1yGPI7tToWKHhYJR+TVilyp+qV3zV8uqdek+d2rjhP7Zcu6D/ToKcq9nstzayKkhpmybFxgWDrFaw9Pp7cexcG9ZtpLBGr9c76lYwm8GhvrCc4h0aUD78NQKsVnG1uv4upV7bjUs8xhIUWO7IVpCBpHKI+838Yn5xzsaqS09WGFx7KvVmbCnFNbIabAuKicLypzHvibAQf3BhJ437oLlOhCYqicoHtw1oDLIusWm6QwNjKQ3cZ9DokmxMah5ZXwXngybG0CVi3kU2aCcWh6me5BXVh3fXN6ek9scx8T83xqgLpkde+Aa1lU5KotyPAv502u+3GdQusnzZ7wuM9DE0fS/HwygVhVY6YtFQBfkGm0gvhP/q1fNspDtR92HB3WPTignIqD+L4Gg67qLXmI/r5jWmh6VytL2Vl6DFOPVpdmg4ydDgtCxL8tPYz2a+oHwbLL+8vYG+/wq4eM/j -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Webhook Events LIST

- - - - - -**Required Permissions**: `Webhook List` or `Webhook Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all webhook events. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    webhook_events object[]
  • Array [
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/webhook-get.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/webhook-get.api.mdx deleted file mode 100644 index 0389dd39..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/webhook-get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: webhook-get -title: "Webhook GET" -description: "**Required Permissions**: `Webhook Get` or `Webhook Admin`" -sidebar_label: "Webhook GET" -hide_title: true -hide_table_of_contents: true -api: eJy1Vllv20YQ/iuLeWmrMjr6yDe1MIo0SG3UCfpgufKQHIkbkbub2aFkVeB/L5aHRB+y3RbRi6Sde+ab4wAZ+ZS1E20NxDAa/UFfK82UqSviUnuvrfGjUazu/qQkt3ajfiW5U5ZPD/Os1OYOInDIWJIQe4hvDmCwJIhh17K9zyACHWw4lBwi4M4QxMIVReDTnEqE+ACyd0FQG6E1MdTRIyc/5aR0puxKSU6qd0NyFLW3ldppnyuxak2iMhRUK7blGOrbYNM7azz5YOan6TR8PdQ9V79dX/6uLpMvlIpKrRHURpu1QtUF8p1vtI4hgkAmI0ELOlfoFIOWyRcfVB2eRmQbrSFTbB2x6NaRTvHrjDp7Pj1tpo8UL6zNGiKgeyxdEZ6uC0w3TzL5ksRlxSF8Q2ngVQnJjsgounfEuiQjXqHJ1FFxxcVzCleWSxSIG3odARlMChrGkVhbEJqh8QCIOgLLGfFrvCssfGAu8X7JJNyl6lGSBgKzaR1ByoRC2RLlRaczFHonuiQYyCT7ZeWJl+eqUblsoNtURRFC7mH+Nlu9joe2zuga2D75+DqakNNcb9+aX9yiID+n9aFXR9blShe0rFxhMVueQccJbpOUrfvMxWQ2nd7PptPJbOzMGr5lqSIotdFlVUI8azrDIUvZ9fN5Tz8ib0h06xyVqF/GfctR1xGIlkbBZ9/WirahiwbCyIz7MCWFSv/msXEWhz29sXOW63xD9i5+y7l0cRwnv7Ql+1cz6iK4p9ZkiIOs2uVkFA6HlMoYV6K0Vx0kxg9K0e2ORg/U4fOE1j4HQkmS2wxiWFOTgrDGYph0afaTw3HT1RCBJ972m7BBP+QizseTiUeTJfZ+jIkvkaXYj1NbNuvJU1qxln0jFGAyd/oDhb+3Q/J12Ctt5odMJxy1D926zQmzBu2PF12QVfOr9+oD7dXKtr+xktyy/rvZZGM1Gn2svKiElDbNtm1xrRYwd/pdENzbitsmQ6eXG9ovYDSCvvYwH+qDbssHwl+dgsXCLxbXPzZl0WZlmzi6EiSYbsiEwyGksvV7Np6Op0+jMerSkQkRXDtK9arbxe1V0PIm5JsQ5j93eW8CDoHvLG/Cjt9pyZuAHqw5x3bNWJYoOsWi2PebH9PQGnUEhU7J+AbpXdRXbB1rEuR9E5izXko0A47jNXXx6XEwh9Nd8f/usQ4OQvcycQVqM9jTLXpv+iHhIYL4dKndRpBbL4HhcEjQ02cu6jo8f62IG0BGsEXW7dy/OUCmfTdHmoXxQkjf9xH9oP7bIXcmsB78JiB/i0UV/kEEm9Abgyu0vq2jvimC5y19nqbkZCD55KALHXgcAaFsdf0PhY3hYA== -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Webhook GET

- - - - - -**Required Permissions**: `Webhook Get` or `Webhook Admin` - -## Request - -

Path Parameters

- -A JSON Object containing a webhook's data. - -
Schema
    webhook object
    created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    events object[]
  • Array [
  • event object
  • ]
- \ No newline at end of file diff --git a/docs/APIs-and-SDKs/Web-Console-API/webhooks-list.api.mdx b/docs/APIs-and-SDKs/Web-Console-API/webhooks-list.api.mdx deleted file mode 100644 index 63697ff0..00000000 --- a/docs/APIs-and-SDKs/Web-Console-API/webhooks-list.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: webhooks-list -title: "Webhooks LIST" -description: "**Required Permissions**: `Webhook List` or `Webhook Admin`" -sidebar_label: "Webhooks LIST" -hide_title: true -hide_table_of_contents: true -api: eJy1Vttu4zYQ/RWCj67Wdgr0xW9uERR7a4I6QR/i1BlJY4trieQOR4lVQ/++oCjH8jXeLdYvtsnh4VwOZ85apugSUpaV0XIke72/8WupCFNxi1Qo55TRrtcbiad/MM6MWYpPyvGTMLRdGaeF0k8ykhYICmQkJ0cPa6mhQDmSzhDLSCqP/7VEqmS0d+tdhsLEXzBhscRKsBH+jOAMBaErc3Yirvoyki7JsAA5WkuubIPNpPRCRhJXUNjcLzW31nW0c/8MXLLvwwFYbEyOoLtoTCV2sSws8E0cpRkXSF2cqy6IYizcj6D8VtePkSR01miHzhv/Ohz6r918jsWHyc1f4iakNDGaQWmlFwK0ACKohJkLyHPxEirofG69GWr2aGBtrhLwaIMvzkOuD/0LBfNVJ2ORWAWHQnCHYdRRSN6xAAulVVEWPk2RZMOQHwfYuNvZbcLxudy79pR36XHkUJlztJrkkCy96U6qz524KcnnXmPibUWM/IKoBa4skipQsxOgU/EKXFJ+DHBuqACWo2a/jiRqiHNML+BtJA2lSG/ZziF33riA1YyQqU3VGTIP60gmhMCYzoDPOp0C4ztW/kluz8TVrHRIs1PVKG3awdZlnvuQQ1TRhXdtMHbvOoHVuXvr49tsAkoy9XxpfuEZGOgY6q5Xr6azucpxVtrcQDo7wY4t3QYJGXtP+eBqOFxdDYeDq77VC/kzS7X3clO0QFy0TeS0p5+BlsgqOIcFqPO8Dxa1bw2KG4B7F2qFz/4V/Xg3aPvJSR5u9pt7TlqdfpAbF39mX7p+bSd/hJJ9V4+69u6JBWokf1a8ZKj9lNg2KZESzFkoJ1pK9HdK0WqABkfW/nOwF5abnQI5M6kcyQU2OQDOPHNf+3okHdLzRj80lJcZs3WjwcCBTmOz6kPsCiDOq35iCukHosOkJMVVc8hzY2zVR/R/H7vbEz/BQrq7RlvyhIV2LmcIaUPx/dHqz4rx7XvxESsxN+E3lJwZUv81M7Mver3PpWMRo1C6kTGBzGIqx1a98wcrU1J4WWDVbInVVPZ6clNwOe7ibdSB3/i3BZhO3XQ6+aWphdJz08TR5j2GZIk6lZH0qQx+X/WH/eFhNFrcWNQ+gonFRM3bqS84AxbBNkbXhDD+vc17E7AP/MXQ0quKF8VZE9DObLNkFgRFAawSyPNqozEg8e+hjmSuEtSuoXcb9S0ZSwoZqGoCs8ZxAbpj0VLKiU/vJ3f74ay3GuZ/CtmWEYwrHtgclO7M50Dah60YeYxkZhz7tfU6Bof3lNe1Xw7azrMyVa5tEs00OOP4xVr4qI9Lz+iN4n6GvPQm0mvPAw+2pq04vsS81b+XmG5U7tb20f8hFSbdw2MdbR6Zz1A4NE4StF3fD6SoR3ltI39e38m6/gZPeGKf -sidebar_class_name: "get api-method" -info_path: docs/APIs-and-SDKs/Web-Console-API/backend -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - -

Webhooks LIST

- - - - - -**Required Permissions**: `Webhook List` or `Webhook Admin` - -## Request - -

Query Parameters

- -A JSON Object containing an array of all webhooks. - -
Schema
    = 1`"} schema={{"type":"integer","minimum":1}}>
    webhooks object[]
  • Array [
  • created_by object
    = 1`"} schema={{"type":"integer","minimum":1}}>
    events object[]
  • Array [
  • event object
  • ]
  • ]
- \ No newline at end of file