{ "openapi": "3.1", "info": { "title": "X", "version": "1.0.0" }, "paths": { "/v1/workflows/abtest": { "post": { "operationId": "Abtest.create", "description": "Creates a new Abtest.", "summary": "Create Abtest", "parameters": [ { "name": "abtestId", "in": "query", "required": false, "description": "Optional ID to use for the abtest, will be autogenerated if not provided.", "schema": { "type": "string", "example": "" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "", "description": "Unique id of the instance for example `workflows/abtest/instances/vxpoqirnwawxzasv4tuu`." }, "displayName": { "type": "string", "example": "", "description": "Human-friendly name of this instance." }, "owner": { "type": "string", "example": "", "description": "The owner of the resource. If not set will default to the creator." }, "jobQueue": { "name": "confidence.workflow.v1.WorkflowInstance.WorkflowJobQueue", "type": "object", "required": [], "properties": { "items": { "type": "array", "items": { "name": "confidence.workflow.v1.WorkflowInstance.WorkflowJob", "type": "object", "required": ["key", "func", "runTime", "isActive"], "properties": { "key": { "type": "string", "example": "", "description": "" }, "func": { "type": "string", "example": "", "description": "" }, "runTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "parameters": { "type": "object", "example": {}, "description": "" }, "isActive": { "type": "boolean", "example": true, "description": "" } } }, "description": "" } }, "description": "" }, "workflowVersion": { "type": "string", "example": "", "description": "Version of the workflow that this instance is running." }, "surfaces": { "type": "array", "items": { "type": "string", "example": "" }, "description": "A set of surfaces that this workflow instance belongs to." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "example": "" }, "description": "Generic labels for the workflow instance." }, "abtest": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.AbTestData", "description": "Module data for abtest" }, "decision": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.DecisionRecordData", "description": "Module data for decision" }, "explore": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ExploreData", "description": "Module data for explore" }, "exposure": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ExposureData", "description": "Module data for exposure" }, "flags": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.FlagsData", "description": "Module data for flags" }, "hypothesis": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.HypothesisData", "description": "Module data for hypothesis" }, "metrics": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.MetricsData", "description": "Module data for metrics" }, "planning": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.PlanningData", "description": "Module data for planning" }, "report": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ReportData", "description": "Module data for report" }, "reviews": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ReviewsData", "description": "Module data for reviews" }, "samplesize": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.SampleSizeData", "description": "Module data for samplesize" }, "stats": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.StatsData", "description": "Module data for stats" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest" } } } } } } }, "/v1/workflows/abtest/instances/{instance}": { "get": { "operationId": "Abtest.get", "description": "Retrieves a abtest by name.", "summary": "Get Abtest", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest" } } } } } }, "patch": { "operationId": "Abtest.update", "description": "Updates an existing abtest.", "summary": "Update Abtest", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "updateMask", "in": "query", "required": false, "description": "Field mask specifying which fields to update.", "schema": { "type": "string", "example": "field1,field2" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "", "description": "Unique id of the instance for example `workflows/abtest/instances/vxpoqirnwawxzasv4tuu`." }, "displayName": { "type": "string", "example": "", "description": "Human-friendly name of this instance." }, "owner": { "type": "string", "example": "", "description": "The owner of the resource. If not set will default to the creator." }, "jobQueue": { "name": "confidence.workflow.v1.WorkflowInstance.WorkflowJobQueue", "type": "object", "required": [], "properties": { "items": { "type": "array", "items": { "name": "confidence.workflow.v1.WorkflowInstance.WorkflowJob", "type": "object", "required": ["key", "func", "runTime", "isActive"], "properties": { "key": { "type": "string", "example": "", "description": "" }, "func": { "type": "string", "example": "", "description": "" }, "runTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "parameters": { "type": "object", "example": {}, "description": "" }, "isActive": { "type": "boolean", "example": true, "description": "" } } }, "description": "" } }, "description": "" }, "workflowVersion": { "type": "string", "example": "", "description": "Version of the workflow that this instance is running." }, "surfaces": { "type": "array", "items": { "type": "string", "example": "" }, "description": "A set of surfaces that this workflow instance belongs to." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "example": "" }, "description": "Generic labels for the workflow instance." }, "abtest": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.AbTestData", "description": "Module data for abtest" }, "decision": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.DecisionRecordData", "description": "Module data for decision" }, "explore": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ExploreData", "description": "Module data for explore" }, "exposure": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ExposureData", "description": "Module data for exposure" }, "flags": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.FlagsData", "description": "Module data for flags" }, "hypothesis": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.HypothesisData", "description": "Module data for hypothesis" }, "metrics": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.MetricsData", "description": "Module data for metrics" }, "planning": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.PlanningData", "description": "Module data for planning" }, "report": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ReportData", "description": "Module data for report" }, "reviews": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ReviewsData", "description": "Module data for reviews" }, "samplesize": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.SampleSizeData", "description": "Module data for samplesize" }, "stats": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.StatsData", "description": "Module data for stats" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest" } } } } } } }, "/v1/workflows/abtest/instances": { "get": { "operationId": "Abtest.list", "description": "Lists abtests with optional filtering and pagination.", "summary": "List Abtest", "parameters": [ { "name": "pageSize", "in": "query", "required": false, "description": "Maximum number of results to return.", "schema": { "type": "integer", "example": 1 } }, { "name": "pageToken", "in": "query", "required": false, "description": "Token for pagination.", "schema": { "type": "string", "example": "" } }, { "name": "filter", "in": "query", "required": false, "description": "Filter expression for results.", "schema": { "type": "string", "example": "" } }, { "name": "orderBy", "in": "query", "required": false, "description": "Field to order results by.", "schema": { "type": "string", "example": "" } }, { "name": "showDeleted", "in": "query", "required": false, "description": "If deleted instances should be included.", "schema": { "type": "boolean", "example": true } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "abtests": { "type": "array", "items": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest" }, "description": "List of abtests." }, "nextPageToken": { "type": "string", "example": "", "description": "Token for fetching the next page of results." } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:addexploratoryanalysis": { "post": { "operationId": "AddExploratoryAnalysis.execute", "description": "Executes the addExploratoryAnalysis function.", "summary": "Execute AddExploratoryAnalysis", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteAddExploratoryAnalysisRequest.Parameters", "type": "object", "required": ["name"], "properties": { "conclusion": { "type": "string", "example": "", "description": "The conclusion text" }, "endTime": { "type": "string", "example": "", "description": "Custom end time for the analysis time window" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteAddExploratoryAnalysisRequest.Parameters.Metric", "type": "object", "required": ["dimensions", "name"], "properties": { "dimensions": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteAddExploratoryAnalysisRequest.Parameters.Metric.Dimension", "type": "object", "required": ["column"], "properties": { "column": { "type": "string", "example": "", "description": "The column name" }, "dimensionTable": { "type": "string", "example": "", "description": "A resource name on the format dimensionTables/abc" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" } } }, "description": "The dimensions" }, "name": { "type": "string", "example": "", "description": "The metric name" } } }, "description": "The metrics to analyze" }, "name": { "type": "string", "example": "", "description": "The analysis name" }, "startTime": { "type": "string", "example": "", "description": "Custom start time for the analysis time window" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "analysisResults": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteAddExploratoryAnalysisResponse.AnalysisResult", "type": "object", "required": ["analysisResult"], "properties": { "analysisResult": { "type": "string", "example": "", "description": "A resource name on the format analysisResults/abc" }, "exposureFilterName": { "type": "string", "example": "", "description": "The exposure filter name" } } }, "description": "Analysis results" }, "conclusion": { "name": "confidence.experiments.abtest.v1.ExecuteAddExploratoryAnalysisResponse.Conclusion", "type": "object", "required": ["text", "updateTime"], "properties": { "text": { "type": "string", "example": "", "description": "The conclusion text" }, "updateTime": { "type": "string", "example": "", "description": "The update time" } }, "description": "The conclusion" }, "createTime": { "type": "string", "example": "", "description": "The create time" }, "createdBy": { "type": "string", "example": "", "description": "A resource name on the format users/abc" }, "endTime": { "type": "string", "example": "", "description": "The end time of the analysis time window" }, "id": { "type": "string", "example": "", "description": "The analysis id" }, "labels": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteAddExploratoryAnalysisResponse.Label", "type": "object", "required": ["key", "value"], "properties": { "key": { "type": "string", "example": "", "description": "The label key" }, "value": { "type": "string", "example": "", "description": "The label value" } } }, "description": "Labels" }, "messages": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Messages" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteAddExploratoryAnalysisResponse.Metric", "type": "object", "required": ["dimensions", "name"], "properties": { "calculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc/metricCalculations/def" }, "calculationError": { "type": "string", "example": "", "description": "Reason calculation creation failed for this metric. Set instead of `calculation`/`scheduledCalculation` when the create/schedule step threw." }, "dimensions": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteAddExploratoryAnalysisResponse.Metric.DimensionsItem", "type": "object", "required": ["column"], "properties": { "column": { "type": "string", "example": "", "description": "The column name" }, "dimensionTable": { "type": "string", "example": "", "description": "A resource name on the format dimensionTables/abc" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" } } }, "description": "The dimensions for the metric" }, "name": { "type": "string", "example": "", "description": "A resource name on the format metrics/abc" }, "scheduledCalculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc" } } }, "description": "The metrics to analyze" }, "name": { "type": "string", "example": "", "description": "The analysis name" }, "splitByExposureFilters": { "type": "boolean", "example": true, "description": "Whether to split by exposure filters" }, "startTime": { "type": "string", "example": "", "description": "The start time of the analysis time window" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "EMPTY", "CALCULATING", "DONE", "ERROR", "STALE" ], "example": "EMPTY", "description": "The analysis state" }, "updateTime": { "type": "string", "example": "", "description": "The update time" }, "useCustomDateRange": { "type": "boolean", "example": true, "description": "Whether the analysis uses a custom date range" }, "useScheduledCalculation": { "type": "boolean", "example": true, "description": "Use scheduled calculations instead of one-time calculations" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:archive": { "post": { "operationId": "ArchiveAction.execute", "description": "Executes the archive action", "summary": "Execute ArchiveAction", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transitionTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the transition should occur." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:clone": { "post": { "operationId": "Clone.clone", "description": "Clones an existing abtest.", "summary": "Clone Clone", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "displayName": { "type": "string", "example": "", "description": "Display name for the cloned instance." }, "parameters": { "type": "object", "example": {}, "description": "Optional parameters to pass to clone handlers." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest" } } } } } } }, "/v1/workflows/abtest/instances/{instance}:converttorollout": { "post": { "operationId": "ConvertToRolloutAction.execute", "description": "Executes the convertToRollout action", "summary": "Execute ConvertToRolloutAction", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transitionTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the transition should occur." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:deleteexploratoryanalysis": { "post": { "operationId": "DeleteExploratoryAnalysis.execute", "description": "Executes the deleteExploratoryAnalysis function.", "summary": "Execute DeleteExploratoryAnalysis", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteDeleteExploratoryAnalysisRequest.Parameters", "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "example": "", "description": "The analysis id" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:deletereviewresponse": { "post": { "operationId": "DeleteReviewResponse.execute", "description": "Executes the deleteReviewResponse function.", "summary": "Execute DeleteReviewResponse", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteDeleteReviewResponseRequest.Parameters", "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "example": "", "description": "The review response id to delete" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "isApproved": { "type": "boolean", "example": true, "description": "Whether the review is approved" }, "responses": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteDeleteReviewResponseResponse.Response", "type": "object", "required": ["reviewer", "state"], "properties": { "commentId": { "type": "string", "example": "", "description": "The comment id" }, "groups": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "id": { "type": "string", "example": "", "description": "The response id" }, "reviewer": { "type": "string", "example": "", "description": "A resource name on the format identities/abc" }, "stale": { "type": "boolean", "example": true, "description": "Whether the review is stale" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The review state" } } }, "description": "The review responses" }, "reviewId": { "type": "string", "example": "", "description": "The review id" }, "reviewers": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteDeleteReviewResponseResponse.Reviewer", "type": "object", "required": ["identity", "role"], "properties": { "identity": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "role": { "type": "string", "enum": [ "ROLE_UNSPECIFIED", "REVIEW_ROLE_UNSPECIFIED", "REQUIRED", "OPTIONAL" ], "example": "REVIEW_ROLE_UNSPECIFIED", "description": "The reviewer role" } } }, "description": "The assigned reviewers" }, "status": { "type": "string", "example": "", "description": "The review status" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:editexploratoryanalysis": { "post": { "operationId": "EditExploratoryAnalysis.execute", "description": "Executes the editExploratoryAnalysis function.", "summary": "Execute EditExploratoryAnalysis", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisRequest.Parameters", "type": "object", "required": ["id"], "properties": { "conclusion": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisRequest.Parameters.Conclusion", "type": "object", "required": ["text"], "properties": { "text": { "type": "string", "example": "", "description": "The conclusion text" } }, "description": "The conclusion" }, "endTime": { "type": "string", "example": "", "description": "Custom end time for the analysis time window" }, "id": { "type": "string", "example": "", "description": "The analysis id" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisRequest.Parameters.Metric", "type": "object", "required": ["dimensions", "name"], "properties": { "calculation": { "type": "string", "example": "", "description": "The metric calculation" }, "dimensions": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisRequest.Parameters.Metric.Dimension", "type": "object", "required": ["column"], "properties": { "column": { "type": "string", "example": "", "description": "The column name" }, "dimensionTable": { "type": "string", "example": "", "description": "A resource name on the format dimensionTables/abc" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" } } }, "description": "The dimensions" }, "metricCalculation": { "type": "string", "example": "", "description": "The metric calculation" }, "name": { "type": "string", "example": "", "description": "The metric name" }, "scheduledCalculation": { "type": "string", "example": "", "description": "The metric calculation" } } }, "description": "The metrics to analyze" }, "name": { "type": "string", "example": "", "description": "The analysis name" }, "skipCalculation": { "type": "boolean", "example": true, "description": "When true, persist metrics without triggering calculations. Useful for saving metric selections before the user is ready to calculate." }, "startTime": { "type": "string", "example": "", "description": "Custom start time for the analysis time window" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "analysisResults": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisResponse.AnalysisResult", "type": "object", "required": ["analysisResult"], "properties": { "analysisResult": { "type": "string", "example": "", "description": "A resource name on the format analysisResults/abc" }, "exposureFilterName": { "type": "string", "example": "", "description": "The exposure filter name" } } }, "description": "Analysis results" }, "conclusion": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisResponse.Conclusion", "type": "object", "required": ["text", "updateTime"], "properties": { "text": { "type": "string", "example": "", "description": "The conclusion text" }, "updateTime": { "type": "string", "example": "", "description": "The update time" } }, "description": "The conclusion" }, "createTime": { "type": "string", "example": "", "description": "The create time" }, "createdBy": { "type": "string", "example": "", "description": "A resource name on the format users/abc" }, "endTime": { "type": "string", "example": "", "description": "The end time of the analysis time window" }, "id": { "type": "string", "example": "", "description": "The analysis id" }, "labels": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisResponse.Label", "type": "object", "required": ["key", "value"], "properties": { "key": { "type": "string", "example": "", "description": "The label key" }, "value": { "type": "string", "example": "", "description": "The label value" } } }, "description": "Labels" }, "messages": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Messages" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisResponse.Metric", "type": "object", "required": ["dimensions", "name"], "properties": { "calculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc/metricCalculations/def" }, "calculationError": { "type": "string", "example": "", "description": "Reason calculation creation failed for this metric. Set instead of `calculation`/`scheduledCalculation` when the create/schedule step threw." }, "dimensions": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteEditExploratoryAnalysisResponse.Metric.DimensionsItem", "type": "object", "required": ["column"], "properties": { "column": { "type": "string", "example": "", "description": "The column name" }, "dimensionTable": { "type": "string", "example": "", "description": "A resource name on the format dimensionTables/abc" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" } } }, "description": "The dimensions for the metric" }, "name": { "type": "string", "example": "", "description": "A resource name on the format metrics/abc" }, "scheduledCalculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc" } } }, "description": "The metrics to analyze" }, "name": { "type": "string", "example": "", "description": "The analysis name" }, "splitByExposureFilters": { "type": "boolean", "example": true, "description": "Whether to split by exposure filters" }, "startTime": { "type": "string", "example": "", "description": "The start time of the analysis time window" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "EMPTY", "CALCULATING", "DONE", "ERROR", "STALE" ], "example": "EMPTY", "description": "The analysis state" }, "updateTime": { "type": "string", "example": "", "description": "The update time" }, "useCustomDateRange": { "type": "boolean", "example": true, "description": "Whether the analysis uses a custom date range" }, "useScheduledCalculation": { "type": "boolean", "example": true, "description": "Use scheduled calculations instead of one-time calculations" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:end": { "post": { "operationId": "EndAction.execute", "description": "Executes the end action", "summary": "Execute EndAction", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transitionTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the transition should occur." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:getexploratoryanalysis": { "post": { "operationId": "GetExploratoryAnalysis.execute", "description": "Executes the getExploratoryAnalysis function.", "summary": "Execute GetExploratoryAnalysis", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteGetExploratoryAnalysisRequest.Parameters", "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "example": "", "description": "The analysis id" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "analysisResults": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteGetExploratoryAnalysisResponse.AnalysisResult", "type": "object", "required": ["analysisResult"], "properties": { "analysisResult": { "type": "string", "example": "", "description": "A resource name on the format analysisResults/abc" }, "exposureFilterName": { "type": "string", "example": "", "description": "The exposure filter name" } } }, "description": "Analysis results" }, "conclusion": { "name": "confidence.experiments.abtest.v1.ExecuteGetExploratoryAnalysisResponse.Conclusion", "type": "object", "required": ["text", "updateTime"], "properties": { "text": { "type": "string", "example": "", "description": "The conclusion text" }, "updateTime": { "type": "string", "example": "", "description": "The update time" } }, "description": "The conclusion" }, "createTime": { "type": "string", "example": "", "description": "The create time" }, "createdBy": { "type": "string", "example": "", "description": "A resource name on the format users/abc" }, "endTime": { "type": "string", "example": "", "description": "The end time of the analysis time window" }, "id": { "type": "string", "example": "", "description": "The analysis id" }, "labels": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteGetExploratoryAnalysisResponse.Label", "type": "object", "required": ["key", "value"], "properties": { "key": { "type": "string", "example": "", "description": "The label key" }, "value": { "type": "string", "example": "", "description": "The label value" } } }, "description": "Labels" }, "messages": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Messages" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteGetExploratoryAnalysisResponse.Metric", "type": "object", "required": ["dimensions", "name"], "properties": { "calculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc/metricCalculations/def" }, "calculationError": { "type": "string", "example": "", "description": "Reason calculation creation failed for this metric. Set instead of `calculation`/`scheduledCalculation` when the create/schedule step threw." }, "dimensions": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteGetExploratoryAnalysisResponse.Metric.DimensionsItem", "type": "object", "required": ["column"], "properties": { "column": { "type": "string", "example": "", "description": "The column name" }, "dimensionTable": { "type": "string", "example": "", "description": "A resource name on the format dimensionTables/abc" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" } } }, "description": "The dimensions for the metric" }, "name": { "type": "string", "example": "", "description": "A resource name on the format metrics/abc" }, "scheduledCalculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc" } } }, "description": "The metrics to analyze" }, "name": { "type": "string", "example": "", "description": "The analysis name" }, "splitByExposureFilters": { "type": "boolean", "example": true, "description": "Whether to split by exposure filters" }, "startTime": { "type": "string", "example": "", "description": "The start time of the analysis time window" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "EMPTY", "CALCULATING", "DONE", "ERROR", "STALE" ], "example": "EMPTY", "description": "The analysis state" }, "updateTime": { "type": "string", "example": "", "description": "The update time" }, "useCustomDateRange": { "type": "boolean", "example": true, "description": "Whether the analysis uses a custom date range" }, "useScheduledCalculation": { "type": "boolean", "example": true, "description": "Use scheduled calculations instead of one-time calculations" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:getmandatorymetrics": { "post": { "operationId": "GetMandatoryMetric.execute", "description": "Executes the getMandatoryMetrics function.", "summary": "Execute GetMandatoryMetric", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "type": "object", "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteGetMandatoryMetricsResponse.MetricMetadata", "type": "object", "required": ["metric"], "properties": { "displayName": { "type": "string", "example": "", "description": "The metric display name" }, "metric": { "type": "string", "example": "", "description": "The metric name" } } }, "description": "Metadata for the mandatory metrics" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteGetMandatoryMetricsResponse.Metric", "type": "object", "required": ["metric"], "properties": { "calculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc/metricCalculations/def" }, "metric": { "type": "string", "example": "", "description": "A resource name on the format metrics/abc" }, "metricRole": { "name": "confidence.experiments.abtest.v1.ExecuteGetMandatoryMetricsResponse.Metric.MetricRole", "type": "object", "required": ["metricKind"], "properties": { "metricKind": { "type": "string", "enum": [ "METRIC_KIND_UNSPECIFIED", "UNKNOWN", "SUCCESS", "GUARDRAIL" ], "example": "UNKNOWN", "description": "The metric kind (success)" }, "minimumDetectableEffect": { "type": "number", "example": 3.14, "description": "The minimum detectable effect for this success metric" }, "nonInferiorityMargin": { "type": "number", "example": 3.14, "description": "The non-inferiority margin for this guardrail metric" } }, "description": "The metric role (success or guardrail)" }, "preferredDirection": { "type": "string", "enum": [ "PREFERRED_DIRECTION_UNSPECIFIED", "INCREASE", "DECREASE", "ANY" ], "example": "INCREASE", "description": "The preferred direction for the metric" }, "schedule": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc" }, "surface": { "type": "string", "example": "", "description": "A resource name on the format surfaces/abc" }, "surfaceOnly": { "type": "boolean", "example": true, "description": "Whether this metric is only from a surface" } } }, "description": "The list of mandatory metrics" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:launch": { "post": { "operationId": "LaunchAction.execute", "description": "Executes the launch action", "summary": "Execute LaunchAction", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transitionTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the transition should occur." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:pauseintake": { "post": { "operationId": "PauseIntake.execute", "description": "Executes the pauseIntake function.", "summary": "Execute PauseIntake", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "type": "object", "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:refreshexploratoryanalysiscalculations": { "post": { "operationId": "RefreshExploratoryAnalysisCalculation.execute", "description": "Executes the refreshExploratoryAnalysisCalculations function.", "summary": "Execute RefreshExploratoryAnalysisCalculation", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteRefreshExploratoryAnalysisCalculationsRequest.Parameters", "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "example": "", "description": "The analysis id" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "analysisResults": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteRefreshExploratoryAnalysisCalculationsResponse.AnalysisResult", "type": "object", "required": ["analysisResult"], "properties": { "analysisResult": { "type": "string", "example": "", "description": "A resource name on the format analysisResults/abc" }, "exposureFilterName": { "type": "string", "example": "", "description": "The exposure filter name" } } }, "description": "Analysis results" }, "conclusion": { "name": "confidence.experiments.abtest.v1.ExecuteRefreshExploratoryAnalysisCalculationsResponse.Conclusion", "type": "object", "required": ["text", "updateTime"], "properties": { "text": { "type": "string", "example": "", "description": "The conclusion text" }, "updateTime": { "type": "string", "example": "", "description": "The update time" } }, "description": "The conclusion" }, "createTime": { "type": "string", "example": "", "description": "The create time" }, "createdBy": { "type": "string", "example": "", "description": "A resource name on the format users/abc" }, "endTime": { "type": "string", "example": "", "description": "The end time of the analysis time window" }, "id": { "type": "string", "example": "", "description": "The analysis id" }, "labels": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteRefreshExploratoryAnalysisCalculationsResponse.Label", "type": "object", "required": ["key", "value"], "properties": { "key": { "type": "string", "example": "", "description": "The label key" }, "value": { "type": "string", "example": "", "description": "The label value" } } }, "description": "Labels" }, "messages": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Messages" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteRefreshExploratoryAnalysisCalculationsResponse.Metric", "type": "object", "required": ["dimensions", "name"], "properties": { "calculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc/metricCalculations/def" }, "calculationError": { "type": "string", "example": "", "description": "Reason calculation creation failed for this metric. Set instead of `calculation`/`scheduledCalculation` when the create/schedule step threw." }, "dimensions": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteRefreshExploratoryAnalysisCalculationsResponse.Metric.DimensionsItem", "type": "object", "required": ["column"], "properties": { "column": { "type": "string", "example": "", "description": "The column name" }, "dimensionTable": { "type": "string", "example": "", "description": "A resource name on the format dimensionTables/abc" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" } } }, "description": "The dimensions for the metric" }, "name": { "type": "string", "example": "", "description": "A resource name on the format metrics/abc" }, "scheduledCalculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc" } } }, "description": "The metrics to analyze" }, "name": { "type": "string", "example": "", "description": "The analysis name" }, "splitByExposureFilters": { "type": "boolean", "example": true, "description": "Whether to split by exposure filters" }, "startTime": { "type": "string", "example": "", "description": "The start time of the analysis time window" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "EMPTY", "CALCULATING", "DONE", "ERROR", "STALE" ], "example": "EMPTY", "description": "The analysis state" }, "updateTime": { "type": "string", "example": "", "description": "The update time" }, "useCustomDateRange": { "type": "boolean", "example": true, "description": "Whether the analysis uses a custom date range" }, "useScheduledCalculation": { "type": "boolean", "example": true, "description": "Use scheduled calculations instead of one-time calculations" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:requestreviews": { "post": { "operationId": "RequestReview.execute", "description": "Executes the requestReviews function.", "summary": "Execute RequestReview", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteRequestReviewsRequest.Parameters", "type": "object", "required": ["reviewers"], "properties": { "reviewers": { "type": "array", "items": { "type": "string", "example": "" }, "description": "The reviewers to request" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "isApproved": { "type": "boolean", "example": true, "description": "Whether the review is approved" }, "responses": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteRequestReviewsResponse.Response", "type": "object", "required": ["reviewer", "state"], "properties": { "commentId": { "type": "string", "example": "", "description": "The comment id" }, "groups": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "id": { "type": "string", "example": "", "description": "The response id" }, "reviewer": { "type": "string", "example": "", "description": "A resource name on the format identities/abc" }, "stale": { "type": "boolean", "example": true, "description": "Whether the review is stale" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The review state" } } }, "description": "The review responses" }, "reviewId": { "type": "string", "example": "", "description": "The review id" }, "reviewers": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteRequestReviewsResponse.Reviewer", "type": "object", "required": ["identity", "role"], "properties": { "identity": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "role": { "type": "string", "enum": [ "ROLE_UNSPECIFIED", "REVIEW_ROLE_UNSPECIFIED", "REQUIRED", "OPTIONAL" ], "example": "REVIEW_ROLE_UNSPECIFIED", "description": "The reviewer role" } } }, "description": "The assigned reviewers" }, "status": { "type": "string", "example": "", "description": "The review status" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:resumeintake": { "post": { "operationId": "ResumeIntake.execute", "description": "Executes the resumeIntake function.", "summary": "Execute ResumeIntake", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "type": "object", "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:retriggerexposure": { "post": { "operationId": "RetriggerExposure.execute", "description": "Retrigger the exposure calculation for this experiment. This will also retrigger all dependent metric calculations if 'retriggerDependentMetrics' is set to true.", "summary": "Execute RetriggerExposure", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteRetriggerExposureRequest.Parameters", "type": "object", "required": ["retriggerDependentMetrics"], "properties": { "retriggerDependentMetrics": { "type": "boolean", "example": true, "description": "Whether to retrigger dependent metric calculations" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:retriggermetric": { "post": { "operationId": "RetriggerMetric.execute", "description": "Retrigger a specific metric calculation for this experiment.", "summary": "Execute RetriggerMetric", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteRetriggerMetricRequest.Parameters", "type": "object", "required": ["metric"], "properties": { "metric": { "type": "string", "example": "", "description": "The metric to retrigger" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } } }, "/v1/workflows/abtest/instances/{instance}:submitreviewresponse": { "post": { "operationId": "SubmitReviewResponse.execute", "description": "Executes the submitReviewResponse function.", "summary": "Execute SubmitReviewResponse", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteSubmitReviewResponseRequest.Parameters", "type": "object", "required": [], "properties": { "action": { "type": "string", "enum": [ "ACTION_UNSPECIFIED", "REJECT", "APPROVE", "REQUESTED" ], "example": "REJECT", "description": "The review action" }, "text": { "type": "string", "example": "", "description": "The review comment text" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "isApproved": { "type": "boolean", "example": true, "description": "Whether the review is approved" }, "responses": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteSubmitReviewResponseResponse.Response", "type": "object", "required": ["reviewer", "state"], "properties": { "commentId": { "type": "string", "example": "", "description": "The comment id" }, "groups": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "id": { "type": "string", "example": "", "description": "The response id" }, "reviewer": { "type": "string", "example": "", "description": "A resource name on the format identities/abc" }, "stale": { "type": "boolean", "example": true, "description": "Whether the review is stale" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The review state" } } }, "description": "The review responses" }, "reviewId": { "type": "string", "example": "", "description": "The review id" }, "reviewers": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteSubmitReviewResponseResponse.Reviewer", "type": "object", "required": ["identity", "role"], "properties": { "identity": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "role": { "type": "string", "enum": [ "ROLE_UNSPECIFIED", "REVIEW_ROLE_UNSPECIFIED", "REQUIRED", "OPTIONAL" ], "example": "REVIEW_ROLE_UNSPECIFIED", "description": "The reviewer role" } } }, "description": "The assigned reviewers" }, "status": { "type": "string", "example": "", "description": "The review status" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:updatereviews": { "post": { "operationId": "UpdateReview.execute", "description": "Executes the updateReviews function.", "summary": "Execute UpdateReview", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "type": "object", "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "isApproved": { "type": "boolean", "example": true, "description": "Whether the review is approved" }, "responses": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteUpdateReviewsResponse.Response", "type": "object", "required": ["reviewer", "state"], "properties": { "commentId": { "type": "string", "example": "", "description": "The comment id" }, "groups": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "id": { "type": "string", "example": "", "description": "The response id" }, "reviewer": { "type": "string", "example": "", "description": "A resource name on the format identities/abc" }, "stale": { "type": "boolean", "example": true, "description": "Whether the review is stale" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The review state" } } }, "description": "The review responses" }, "reviewId": { "type": "string", "example": "", "description": "The review id" }, "reviewers": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.ExecuteUpdateReviewsResponse.Reviewer", "type": "object", "required": ["identity", "role"], "properties": { "identity": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "role": { "type": "string", "enum": [ "ROLE_UNSPECIFIED", "REVIEW_ROLE_UNSPECIFIED", "REQUIRED", "OPTIONAL" ], "example": "REVIEW_ROLE_UNSPECIFIED", "description": "The reviewer role" } } }, "description": "The assigned reviewers" }, "status": { "type": "string", "example": "", "description": "The review status" } } } } } } } } }, "/v1/workflows/abtest/instances/{instance}:updatesegment": { "post": { "operationId": "UpdateSegment.execute", "description": "Executes the updateSegment function.", "summary": "Execute UpdateSegment", "parameters": [ { "name": "instance", "in": "path", "required": true, "schema": { "type": "string" } } ], "servers": [ { "url": "https://experiments.confidence.dev" }, { "url": "https://experiments.eu.confidence.dev" }, { "url": "https://experiments.us.confidence.dev" } ], "security": [ { "admin": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parameters": { "name": "confidence.experiments.abtest.v1.ExecuteUpdateSegmentRequest.Parameters", "type": "object", "required": ["segment", "updateMask"], "properties": { "ignoreTargetingForSticky": { "type": "boolean", "example": true, "description": "Whether to ignore targeting for sticky assignments" }, "segment": { "name": "confidence.experiments.abtest.v1.ExecuteUpdateSegmentRequest.Parameters.Segment", "type": "object", "required": [], "properties": { "allocation": { "name": "confidence.experiments.abtest.v1.ExecuteUpdateSegmentRequest.Parameters.Segment.SegmentAllocation", "type": "object", "required": [], "properties": { "proportion": { "name": "confidence.experiments.abtest.v1.ExecuteUpdateSegmentRequest.Parameters.Segment.SegmentAllocation.AllocationProportion", "type": "object", "required": [], "properties": { "value": { "type": "string", "example": "", "description": "The allocation proportion value as a decimal string" } }, "description": "The allocation proportion configuration" } }, "description": "The allocation configuration for the segment" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "example": "" }, "description": "Labels for the segment" }, "name": { "type": "string", "example": "", "description": "The segment name" }, "targeting": { "name": "confidence.flags.types.v1.Targeting", "type": "object", "required": [], "properties": { "criteria": { "type": "object", "additionalProperties": { "name": "confidence.flags.types.v1.Targeting.Criterion", "type": "object", "required": [], "properties": { "attribute": { "name": "confidence.flags.types.v1.Targeting.Criterion.AttributeCriterion", "type": "object", "required": [], "properties": { "attributeName": { "type": "string", "example": "", "description": "" }, "eqRule": { "name": "confidence.flags.types.v1.Targeting.EqRule", "type": "object", "required": [], "properties": { "value": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "same as SetRule with a single value" }, "setRule": { "name": "confidence.flags.types.v1.Targeting.SetRule", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "represents a set of allowed values\n in \\{a, b, c} -{\">\"} x == a || x == b || x == c || ...\n not in \\{a, b} -{\">\"} x != a && x != b && ..." }, "rangeRule": { "name": "confidence.flags.types.v1.Targeting.RangeRule", "type": "object", "required": [], "properties": { "startInclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "startExclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "endInclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "endExclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "represents a criteria on a value using inequalities\n closed range start, end -{\">\"} start {\"<\"}[=] x && x {\"<\"}[=] end\n open end start, ... -{\">\"} start {\"<\"}[=] x\n open start ..., end -{\">\"} x {\"<\"}[=] end" }, "anyRule": { "name": "confidence.flags.types.v1.Targeting.AnyRule", "type": "object", "required": [], "properties": { "rule": { "name": "confidence.flags.types.v1.Targeting.InnerRule", "type": "object", "required": [], "properties": { "eqRule": { "name": "confidence.flags.types.v1.Targeting.EqRule", "type": "object", "required": [], "properties": { "value": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "same as SetRule with a single value" }, "setRule": { "name": "confidence.flags.types.v1.Targeting.SetRule", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "represents a set of allowed values\n in \\{a, b, c} -{\">\"} x == a || x == b || x == c || ...\n not in \\{a, b} -{\">\"} x != a && x != b && ..." }, "rangeRule": { "name": "confidence.flags.types.v1.Targeting.RangeRule", "type": "object", "required": [], "properties": { "startInclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "startExclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "endInclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "endExclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "represents a criteria on a value using inequalities\n closed range start, end -{\">\"} start {\"<\"}[=] x && x {\"<\"}[=] end\n open end start, ... -{\">\"} start {\"<\"}[=] x\n open start ..., end -{\">\"} x {\"<\"}[=] end" } }, "description": "" } }, "description": "is match if at least one input item matches the inner rule\n is not match if the input list is empty/missing" }, "allRule": { "name": "confidence.flags.types.v1.Targeting.AllRule", "type": "object", "required": [], "properties": { "rule": { "name": "confidence.flags.types.v1.Targeting.InnerRule", "type": "object", "required": [], "properties": { "eqRule": { "name": "confidence.flags.types.v1.Targeting.EqRule", "type": "object", "required": [], "properties": { "value": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "same as SetRule with a single value" }, "setRule": { "name": "confidence.flags.types.v1.Targeting.SetRule", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "represents a set of allowed values\n in \\{a, b, c} -{\">\"} x == a || x == b || x == c || ...\n not in \\{a, b} -{\">\"} x != a && x != b && ..." }, "rangeRule": { "name": "confidence.flags.types.v1.Targeting.RangeRule", "type": "object", "required": [], "properties": { "startInclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "startExclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "endInclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" }, "endExclusive": { "name": "confidence.flags.types.v1.Targeting.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "versionValue": { "name": "confidence.flags.types.v1.Targeting.SemanticVersion", "type": "object", "required": [], "properties": { "version": { "type": "string", "example": "", "description": "" } }, "description": "" }, "listValue": { "name": "confidence.flags.types.v1.Targeting.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version" } }, "description": "represents a criteria on a value using inequalities\n closed range start, end -{\">\"} start {\"<\"}[=] x && x {\"<\"}[=] end\n open end start, ... -{\">\"} start {\"<\"}[=] x\n open start ..., end -{\">\"} x {\"<\"}[=] end" } }, "description": "" } }, "description": "is match if each and every input item matches the inner rule\n is also match if the input field is empty/missing" } }, "description": "" }, "segment": { "name": "confidence.flags.types.v1.Targeting.Criterion.SegmentCriterion", "type": "object", "required": [], "properties": { "segment": { "type": "string", "example": "", "description": "" } }, "description": "" } } }, "description": "" }, "expression": { "name": "confidence.flags.types.v1.Expression", "type": "object", "required": [], "properties": { "ref": { "type": "string", "example": "", "description": "" }, "not": { "type": "object", "description": "A boolean expression with leaf nodes that reference criteria elements" }, "and": { "name": "confidence.flags.types.v1.Expression.Operands", "type": "object", "required": [], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements" } }, "description": "" }, "or": { "name": "confidence.flags.types.v1.Expression.Operands", "type": "object", "required": [], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements" } }, "description": "" } }, "description": "A boolean expression with leaf nodes that reference criteria elements" } }, "description": "The targeting configuration for the segment" } }, "description": "The segment to update" }, "stickyAssignments": { "type": "boolean", "example": true, "description": "Whether to use sticky assignments" }, "targetingKeySelector": { "type": "string", "example": "", "description": "The targeting key selector for user assignment" }, "updateMask": { "type": "string", "example": "", "description": "Comma-separated list of field paths to update" } }, "description": "Parameters for the function." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "pathAimedToUpdate": { "type": "string", "example": "", "description": "The field path that was aimed to be updated" } } } } } } } } } }, "components": { "schemas": { "confidence.experiments.abtest.v1.Abtest": { "type": "object", "description": "Represents a Abtest.", "properties": { "name": { "type": "string", "example": "", "description": "Unique id of the instance for example `workflows/abtest/instances/vxpoqirnwawxzasv4tuu`." }, "displayName": { "type": "string", "example": "", "description": "Human-friendly name of this instance." }, "owner": { "type": "string", "example": "", "description": "The owner of the resource. If not set will default to the creator." }, "state": { "type": "string", "example": "", "description": "Current state of the workflow instance." }, "jobQueue": { "name": "confidence.workflow.v1.WorkflowInstance.WorkflowJobQueue", "type": "object", "required": ["isEnabled"], "properties": { "isEnabled": { "type": "boolean", "example": true, "description": "" }, "items": { "type": "array", "items": { "name": "confidence.workflow.v1.WorkflowInstance.WorkflowJob", "type": "object", "required": ["key", "func", "runTime", "isActive"], "properties": { "key": { "type": "string", "example": "", "description": "" }, "func": { "type": "string", "example": "", "description": "" }, "runTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "parameters": { "type": "object", "example": {}, "description": "" }, "isActive": { "type": "boolean", "example": true, "description": "" } } }, "description": "" } }, "description": "" }, "pendingTransition": { "name": "confidence.workflow.v1.WorkflowInstance.PendingTransition", "type": "object", "required": ["transitionAction", "targetState"], "properties": { "transitionAction": { "type": "string", "example": "", "description": "the action that was triggered" }, "targetState": { "type": "string", "example": "", "description": "the state that the workflow instance is attempting to transition to" }, "succeededSteps": { "type": "array", "items": { "type": "string", "example": "" }, "description": "steps that have been completed as part of the transition" }, "failedSteps": { "type": "array", "items": { "name": "confidence.workflow.v1.WorkflowInstance.PendingTransition.FailedActionStep", "type": "object", "required": ["actionStep"], "properties": { "actionStep": { "type": "string", "example": "", "description": "" }, "failuresMessages": { "type": "array", "items": { "type": "string", "example": "" }, "description": "" } } }, "description": "steps that have failed as part of the transition" }, "unprocessedSteps": { "type": "array", "items": { "type": "string", "example": "" }, "description": "steps that have not yet been processed as part of the transition" }, "succeededActions": { "type": "array", "items": { "type": "string", "example": "" }, "description": "" }, "failedActions": { "type": "array", "items": { "name": "confidence.workflow.v1.WorkflowInstance.PendingTransition.FailedAction", "type": "object", "required": ["action"], "properties": { "action": { "type": "string", "example": "", "description": "" }, "failuresMessages": { "type": "array", "items": { "type": "string", "example": "" }, "description": "" } } }, "description": "" }, "unprocessedActions": { "type": "array", "items": { "type": "string", "example": "" }, "description": "" } }, "description": "if present, denotes information about an ongoing attempt to transition to another state" }, "checks": { "type": "array", "items": { "name": "confidence.workflow.v1.WorkflowInstance.Check", "type": "object", "required": [ "message", "state", "persist", "createTime", "updateTime", "creator", "updater" ], "properties": { "name": { "type": "string", "example": "", "description": "The name of the check, for example, `workflows/abtest/instances/vxpoqirnwawxzasv4tuu/checks/ndcrhu0tzbin85xzpszv." }, "displayName": { "type": "string", "example": "", "description": "display name of the check" }, "message": { "type": "string", "example": "", "description": "Status message of a check." }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "SUCCEEDED", "FAILED" ], "example": "PENDING", "description": "\n The state of the check." }, "persist": { "type": "boolean", "example": true, "description": "Determines whether the check should be kept between state transitions." }, "parent": { "type": "string", "example": "", "description": "\n A possible parent check that this check is nested under." }, "data": { "name": "google.protobuf.Value", "type": "object", "required": [], "properties": { "nullValue": { "type": "string", "enum": ["NULL_VALUE"], "example": "NULL_VALUE", "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "boolValue": { "type": "boolean", "example": true, "description": "" }, "structValue": { "type": "object", "example": {}, "description": "" }, "listValue": { "name": "google.protobuf.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "" } }, "description": "" } }, "description": "Custom data for the check." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "example": "" }, "description": "Custom labels for this check." }, "createTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the check was first created." }, "updateTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the entity was last updated." }, "creator": { "type": "string", "example": "", "description": "Reference to the identity that created this check." }, "updater": { "type": "string", "example": "", "description": "Reference to the identity that last updated this check." } } }, "description": "A check is a named boolean value that can be used to report possible errors when a workflow\n instance is in a certain state." }, "stateHistory": { "type": "array", "items": { "name": "confidence.workflow.v1.WorkflowInstance.StateHistory", "type": "object", "required": [], "properties": { "state": { "type": "string", "example": "", "description": "The historical state" }, "enteredTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The timestamp at which the workflow instance entered this state" }, "exitedTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The timestamp at which the workflow instance exited this state" }, "actualEnteredTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The actual timestamp, as defined by an external system, that the workflow instance entered this state" }, "actualExitedTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The actual timestamp, as defined by an external system, that the workflow instance exited this state" }, "checks": { "type": "array", "items": { "name": "confidence.workflow.v1.WorkflowInstance.Check", "type": "object", "required": [ "message", "state", "persist", "createTime", "updateTime", "creator", "updater" ], "properties": { "name": { "type": "string", "example": "", "description": "The name of the check, for example, `workflows/abtest/instances/vxpoqirnwawxzasv4tuu/checks/ndcrhu0tzbin85xzpszv." }, "displayName": { "type": "string", "example": "", "description": "display name of the check" }, "message": { "type": "string", "example": "", "description": "Status message of a check." }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "SUCCEEDED", "FAILED" ], "example": "PENDING", "description": "\n The state of the check." }, "persist": { "type": "boolean", "example": true, "description": "Determines whether the check should be kept between state transitions." }, "parent": { "type": "string", "example": "", "description": "\n A possible parent check that this check is nested under." }, "data": { "name": "google.protobuf.Value", "type": "object", "required": [], "properties": { "nullValue": { "type": "string", "enum": ["NULL_VALUE"], "example": "NULL_VALUE", "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "boolValue": { "type": "boolean", "example": true, "description": "" }, "structValue": { "type": "object", "example": {}, "description": "" }, "listValue": { "name": "google.protobuf.ListValue", "type": "object", "required": [], "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "" } }, "description": "" } }, "description": "Custom data for the check." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "example": "" }, "description": "Custom labels for this check." }, "createTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the check was first created." }, "updateTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the entity was last updated." }, "creator": { "type": "string", "example": "", "description": "Reference to the identity that created this check." }, "updater": { "type": "string", "example": "", "description": "Reference to the identity that last updated this check." } } }, "description": "All the checks that were present when the workflow instance transitioned away from this state" } } }, "description": "A historical record of previous states that the workflow instance was in." }, "possibleTransitions": { "type": "array", "items": { "type": "string", "example": "" }, "description": "The transitions that this workflow instance can do from its current state." }, "lockedDataKeys": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Module data keys that are currently locked." }, "workflowVersion": { "type": "string", "example": "", "description": "Version of the workflow that this instance is running." }, "surfaces": { "type": "array", "items": { "type": "string", "example": "" }, "description": "A set of surfaces that this workflow instance belongs to." }, "transitionStatus": { "name": "confidence.workflow.v1.WorkflowInstance.TransitionStatus", "type": "object", "required": ["action", "initiator"], "properties": { "action": { "type": "string", "example": "", "description": "" }, "initiator": { "type": "string", "example": "", "description": "" }, "running": { "name": "confidence.workflow.v1.WorkflowInstance.TransitionStatus.Running", "type": "object", "required": ["startTime"], "properties": { "startTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time when the transition was started." } }, "description": "" }, "completed": { "name": "confidence.workflow.v1.WorkflowInstance.TransitionStatus.Completed", "type": "object", "required": ["startTime", "endTime"], "properties": { "startTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time when the transition was started." }, "endTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time when the transition was completed." } }, "description": "" }, "failed": { "name": "confidence.workflow.v1.WorkflowInstance.TransitionStatus.Failed", "type": "object", "required": ["startTime", "endTime", "error"], "properties": { "startTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time when the transition was started." }, "endTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time when the transition failed." }, "error": { "type": "string", "example": "", "description": "The error message of the failure." } }, "description": "" } }, "description": "The status of the latest transition for the instance." }, "createTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the workflow instance was created." }, "updateTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the workflow instance was last updated." }, "deleteTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when the workflow instance was deleted." }, "creator": { "type": "string", "example": "", "description": "Reference to the identity that created this workflow instance." }, "updater": { "type": "string", "example": "", "description": "Reference to the identity that last updated this workflow instance." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "example": "" }, "description": "Generic labels for the workflow instance." }, "abtest": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.AbTestData", "description": "Module data for abtest" }, "decision": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.DecisionRecordData", "description": "Module data for decision" }, "explore": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ExploreData", "description": "Module data for explore" }, "exposure": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ExposureData", "description": "Module data for exposure" }, "flags": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.FlagsData", "description": "Module data for flags" }, "hypothesis": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.HypothesisData", "description": "Module data for hypothesis" }, "metrics": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.MetricsData", "description": "Module data for metrics" }, "planning": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.PlanningData", "description": "Module data for planning" }, "report": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ReportData", "description": "Module data for report" }, "reviews": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.ReviewsData", "description": "Module data for reviews" }, "samplesize": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.SampleSizeData", "description": "Module data for samplesize" }, "stats": { "$ref": "#/components/schemas/confidence.experiments.abtest.v1.Abtest.StatsData", "description": "Module data for stats" } } }, "confidence.experiments.abtest.v1.Abtest.AbTestData": { "type": "object", "description": "Module data for abtest", "properties": { "flag": { "type": "string", "example": "", "description": "" }, "rollout": { "type": "string", "example": "", "description": "" }, "treatments": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.AbTestData.Treatment", "type": "object", "required": ["variant", "weight"], "properties": { "description": { "type": "string", "example": "", "description": "" }, "displayName": { "type": "string", "example": "", "description": "" }, "imageUri": { "type": "string", "example": "", "description": "" }, "name": { "type": "string", "example": "", "description": "" }, "variant": { "type": "string", "example": "", "description": "" }, "weight": { "type": "integer", "example": 1, "description": "" } } }, "description": "" } } }, "confidence.experiments.abtest.v1.Abtest.DecisionRecordData": { "type": "object", "description": "Module data for decision", "properties": { "conclusion": { "type": "string", "example": "", "description": "The decision conclusion" }, "outcome": { "type": "string", "enum": [ "OUTCOME_UNSPECIFIED", "shipped", "abandoned", "aborted", "restarted" ], "example": "shipped", "description": "The decision outcome" }, "treatment": { "type": "string", "example": "", "description": "The selected treatment" } } }, "confidence.experiments.abtest.v1.Abtest.ExploreData": { "type": "object", "description": "Module data for explore", "properties": { "exploratoryAnalyses": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ExploreData.Analysis", "type": "object", "required": [ "createTime", "id", "messages", "metrics", "name", "state", "updateTime" ], "properties": { "analysisResults": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ExploreData.Analysis.AnalysisResult", "type": "object", "required": ["analysisResult"], "properties": { "analysisResult": { "type": "string", "example": "", "description": "A resource name on the format analysisResults/abc" }, "exposureFilterName": { "type": "string", "example": "", "description": "The exposure filter name" } } }, "description": "Analysis results" }, "conclusion": { "name": "confidence.experiments.abtest.v1.Abtest.ExploreData.Analysis.Conclusion", "type": "object", "required": ["text", "updateTime"], "properties": { "text": { "type": "string", "example": "", "description": "The conclusion text" }, "updateTime": { "type": "string", "example": "", "description": "The update time" } }, "description": "The conclusion" }, "createTime": { "type": "string", "example": "", "description": "The create time" }, "createdBy": { "type": "string", "example": "", "description": "A resource name on the format users/abc" }, "endTime": { "type": "string", "example": "", "description": "The end time of the analysis time window" }, "id": { "type": "string", "example": "", "description": "The analysis id" }, "labels": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ExploreData.Analysis.Label", "type": "object", "required": ["key", "value"], "properties": { "key": { "type": "string", "example": "", "description": "The label key" }, "value": { "type": "string", "example": "", "description": "The label value" } } }, "description": "Labels" }, "messages": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Messages" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ExploreData.Analysis.Metric", "type": "object", "required": ["dimensions", "name"], "properties": { "calculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc/metricCalculations/def" }, "calculationError": { "type": "string", "example": "", "description": "Reason calculation creation failed for this metric. Set instead of `calculation`/`scheduledCalculation` when the create/schedule step threw." }, "dimensions": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ExploreData.Analysis.Metric.DimensionsItem", "type": "object", "required": ["column"], "properties": { "column": { "type": "string", "example": "", "description": "The column name" }, "dimensionTable": { "type": "string", "example": "", "description": "A resource name on the format dimensionTables/abc" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" } } }, "description": "The dimensions for the metric" }, "name": { "type": "string", "example": "", "description": "A resource name on the format metrics/abc" }, "scheduledCalculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc" } } }, "description": "The metrics to analyze" }, "name": { "type": "string", "example": "", "description": "The analysis name" }, "splitByExposureFilters": { "type": "boolean", "example": true, "description": "Whether to split by exposure filters" }, "startTime": { "type": "string", "example": "", "description": "The start time of the analysis time window" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "EMPTY", "CALCULATING", "DONE", "ERROR", "STALE" ], "example": "EMPTY", "description": "The analysis state" }, "updateTime": { "type": "string", "example": "", "description": "The update time" }, "useCustomDateRange": { "type": "boolean", "example": true, "description": "Whether the analysis uses a custom date range" }, "useScheduledCalculation": { "type": "boolean", "example": true, "description": "Use scheduled calculations instead of one-time calculations" } } }, "description": "The list of exploratory analyses" } } }, "confidence.experiments.abtest.v1.Abtest.ExposureData": { "type": "object", "description": "Module data for exposure", "properties": { "exposure": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ExposureData.ExposureEntry", "type": "object", "required": ["totalExposureCount", "treatment"], "properties": { "exposureFilter": { "type": "string", "example": "", "description": "The exposure filter name" }, "totalExposureCount": { "type": "integer", "example": 1, "description": "Total exposure count" }, "treatment": { "type": "string", "example": "", "description": "The treatment identifier" } } }, "description": "Exposure entries" } } }, "confidence.experiments.abtest.v1.Abtest.FlagsData": { "type": "object", "description": "Module data for flags", "properties": { "audiences": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.FlagsData.Audience", "type": "object", "required": ["id"], "properties": { "displayName": { "type": "string", "example": "", "description": "The audience display name" }, "id": { "type": "string", "example": "", "description": "The audience id" }, "intakePaused": { "type": "boolean", "example": true, "description": "Whether intake is paused for this audience" }, "launchTime": { "type": "string", "example": "", "description": "The time when the audience was launched" }, "materialization": { "type": "string", "example": "", "description": "A resource name on the format materializedSegments/abc" }, "rule": { "type": "string", "example": "", "description": "A resource name on the format flags/abc/rules/def" }, "segment": { "type": "string", "example": "", "description": "A resource name on the format segments/abc" }, "stopTime": { "type": "string", "example": "", "description": "The time when the audience was stopped" } } }, "description": "The list of audiences for this workflow" }, "flag": { "type": "string", "example": "", "description": "A resource name on the format flags/abc" }, "ignoreTargetingForSticky": { "type": "boolean", "example": true, "description": "Whether to ignore targeting for sticky assignments" }, "intakePaused": { "type": "boolean", "example": true, "description": "Whether intake is paused" }, "materialization": { "type": "string", "example": "", "description": "A resource name on the format materializedSegments/abc" }, "rule": { "type": "string", "example": "", "description": "A resource name on the format rules/abc" }, "segment": { "type": "string", "example": "", "description": "A resource name on the format segments/abc" }, "stickyAssignments": { "type": "boolean", "example": true, "description": "Whether to use sticky assignments" }, "targetingKeySelector": { "type": "string", "example": "", "description": "The targeting key selector for user assignment" } } }, "confidence.experiments.abtest.v1.Abtest.HypothesisData": { "type": "object", "description": "Module data for hypothesis", "properties": { "text": { "type": "string", "example": "", "description": "The hypothesis text" } } }, "confidence.experiments.abtest.v1.Abtest.MetricsData": { "type": "object", "description": "Module data for metrics", "properties": { "assignmentTable": { "type": "string", "example": "", "description": "A resource name on the format assignmentTables/abc" }, "assignmentTableSource": { "type": "string", "enum": ["ASSIGNMENT_TABLE_SOURCE_UNSPECIFIED", "AUTO", "MANUAL"], "example": "AUTO", "description": "Whether assignmentTable is derived from the entity (AUTO) or set by the user (MANUAL). Defaults to AUTO when unset." }, "bucket": { "type": "string", "enum": [ "BUCKET_UNSPECIFIED", "BUCKETING_TEMPORAL_UNIT_UNSPECIFIED", "HOURS", "DAYS" ], "example": "BUCKETING_TEMPORAL_UNIT_UNSPECIFIED", "description": "The bucketing temporal unit for metric collection" }, "entity": { "type": "string", "example": "", "description": "A resource name on the format entities/abc" }, "entitySource": { "type": "string", "enum": ["ENTITY_SOURCE_UNSPECIFIED", "AUTO", "MANUAL"], "example": "AUTO", "description": "Whether entity is derived from the targeting key (AUTO) or set by the user (MANUAL). Defaults to AUTO when unset." }, "exposureCalculation": { "type": "string", "example": "", "description": "A resource name on the format exposureCalculations/abc" }, "exposureFilter": { "name": "confidence.experiments.abtest.v1.Abtest.MetricsData.ExposureFilter", "type": "object", "required": [], "properties": { "displayName": { "type": "string", "example": "", "description": "Display name for the exposure filter" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" }, "filter": { "name": "confidence.metrics.v1.Filter", "type": "object", "required": ["criteria", "expression"], "properties": { "criteria": { "type": "object", "additionalProperties": { "name": "confidence.metrics.v1.Filter.Criterion", "type": "object", "required": [], "properties": { "attribute": { "name": "confidence.metrics.v1.Filter.Criterion.AttributeCriterion", "type": "object", "required": ["attribute"], "properties": { "attribute": { "type": "string", "example": "", "description": "The name of the attribute" }, "eqRule": { "name": "confidence.metrics.v1.Filter.EqRule", "type": "object", "required": ["value"], "properties": { "value": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be equal to the criterion" }, "setRule": { "name": "confidence.metrics.v1.Filter.SetRule", "type": "object", "required": ["values"], "properties": { "values": { "type": "array", "items": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be in the set of values" }, "rangeRule": { "name": "confidence.metrics.v1.Filter.RangeRule", "type": "object", "required": [], "properties": { "startInclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "startExclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "endInclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "endExclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be in the range" } }, "description": "A criterion for an attribute (typically a table column)" } } }, "description": "The filter criteria" }, "expression": { "name": "confidence.metrics.v1.Expression", "type": "object", "required": [], "properties": { "ref": { "type": "string", "example": "", "description": "" }, "not": { "type": "object", "description": "A boolean expression with leaf nodes that reference criteria elements\n " }, "and": { "name": "confidence.metrics.v1.Expression.Operands", "type": "object", "required": ["operands"], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements\n " } }, "description": "" }, "or": { "name": "confidence.metrics.v1.Expression.Operands", "type": "object", "required": ["operands"], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements\n " } }, "description": "" } }, "description": "The filter expressions" } }, "description": "Filter configuration" } }, "description": "The exposure filter configuration" }, "exposureMetric": { "type": "string", "example": "", "description": "A resource name on the format metrics/abc" }, "exposureMetricCalculation": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc/metricCalculations/def" }, "exposureMetricSchedule": { "type": "string", "example": "", "description": "A resource name on the format scheduledMetricCalculations/abc" }, "exposureTable": { "type": "string", "example": "", "description": "A resource name on the format exposureTables/abc" }, "exposureTableSchedule": { "type": "string", "example": "", "description": "A resource name on the format scheduledExposureCalculations/abc" }, "filters": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.MetricsData.ExposureFilter", "type": "object", "required": [], "properties": { "displayName": { "type": "string", "example": "", "description": "Display name for the exposure filter" }, "factTable": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" }, "filter": { "name": "confidence.metrics.v1.Filter", "type": "object", "required": ["criteria", "expression"], "properties": { "criteria": { "type": "object", "additionalProperties": { "name": "confidence.metrics.v1.Filter.Criterion", "type": "object", "required": [], "properties": { "attribute": { "name": "confidence.metrics.v1.Filter.Criterion.AttributeCriterion", "type": "object", "required": ["attribute"], "properties": { "attribute": { "type": "string", "example": "", "description": "The name of the attribute" }, "eqRule": { "name": "confidence.metrics.v1.Filter.EqRule", "type": "object", "required": ["value"], "properties": { "value": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be equal to the criterion" }, "setRule": { "name": "confidence.metrics.v1.Filter.SetRule", "type": "object", "required": ["values"], "properties": { "values": { "type": "array", "items": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be in the set of values" }, "rangeRule": { "name": "confidence.metrics.v1.Filter.RangeRule", "type": "object", "required": [], "properties": { "startInclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "startExclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "endInclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "endExclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be in the range" } }, "description": "A criterion for an attribute (typically a table column)" } } }, "description": "The filter criteria" }, "expression": { "name": "confidence.metrics.v1.Expression", "type": "object", "required": [], "properties": { "ref": { "type": "string", "example": "", "description": "" }, "not": { "type": "object", "description": "A boolean expression with leaf nodes that reference criteria elements\n " }, "and": { "name": "confidence.metrics.v1.Expression.Operands", "type": "object", "required": ["operands"], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements\n " } }, "description": "" }, "or": { "name": "confidence.metrics.v1.Expression.Operands", "type": "object", "required": ["operands"], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements\n " } }, "description": "" } }, "description": "The filter expressions" } }, "description": "Filter configuration" } } }, "description": "Additional exposure filters" }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.MetricsData.Metric", "type": "object", "required": ["metric"], "properties": { "calculation": { "type": "string", "example": "", "description": "Display name for the exposure filter" }, "metric": { "type": "string", "example": "", "description": "A resource name on the format factTables/abc" }, "metricRole": { "name": "confidence.experiments.abtest.v1.Abtest.MetricsData.Metric.MetricRole", "type": "object", "required": ["metricKind"], "properties": { "metricKind": { "type": "string", "enum": [ "METRIC_KIND_UNSPECIFIED", "UNKNOWN", "SUCCESS", "GUARDRAIL" ], "example": "UNKNOWN", "description": "" }, "minimumDetectableEffect": { "type": "number", "example": 3.14, "description": "" }, "nonInferiorityMargin": { "type": "number", "example": 3.14, "description": "" } }, "description": "Filter configuration" }, "preferredDirection": { "type": "string", "enum": [ "PREFERRED_DIRECTION_UNSPECIFIED", "INCREASE", "DECREASE", "ANY" ], "example": "INCREASE", "description": "" }, "schedule": { "type": "string", "example": "", "description": "" }, "surface": { "type": "string", "example": "", "description": "" }, "surfaceOnly": { "type": "boolean", "example": true, "description": "" } } }, "description": "The list of metrics" } } }, "confidence.experiments.abtest.v1.Abtest.PlanningData": { "type": "object", "description": "Module data for planning", "properties": { "actual": { "name": "confidence.experiments.abtest.v1.Abtest.PlanningData.Period", "type": "object", "required": [], "properties": { "endTime": { "type": "string", "example": "", "description": "The end time" }, "runtime": { "type": "string", "example": "", "description": "The runtime duration" }, "startTime": { "type": "string", "example": "", "description": "The start time" } }, "description": "The actual time period" }, "planned": { "name": "confidence.experiments.abtest.v1.Abtest.PlanningData.Period", "type": "object", "required": [], "properties": { "endTime": { "type": "string", "example": "", "description": "The end time" }, "runtime": { "type": "string", "example": "", "description": "The runtime duration" }, "startTime": { "type": "string", "example": "", "description": "The start time" } }, "description": "The planned time period" } } }, "confidence.experiments.abtest.v1.Abtest.RecommendationsData": { "type": "object", "description": "Module data for recommendations", "properties": { "recommendations": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.RecommendationsData.TreatmentRecommendations", "type": "object", "required": [], "properties": { "exposureFilterName": { "type": "string", "example": "", "description": "" }, "treatmentRecommendations": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.RecommendationsData.TreatmentRecommendations.TreatmentInformation", "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "example": "", "description": "" }, "recommendation": { "name": "confidence.experiments.abtest.v1.Abtest.RecommendationsData.TreatmentRecommendations.TreatmentInformation.Recommendation", "type": "object", "required": ["shipping", "status"], "properties": { "shipping": { "type": "string", "enum": [ "SHIPPING_UNSPECIFIED", "SHIP", "SHIP_WITH_CAUTION", "CONTINUE", "END", "ABORT", "DONT_SHIP", "WAIT_FOR_DATA", "ENOUGH_DATA_COLLECTED", "UNSPECIFIED" ], "example": "SHIP", "description": "" }, "status": { "name": "confidence.experiments.abtest.v1.Abtest.RecommendationsData.TreatmentRecommendations.TreatmentInformation.Recommendation.RecommendationStatus", "type": "object", "required": ["guardrail", "success", "tanking"], "properties": { "guardrail": { "type": "string", "enum": [ "GUARDRAIL_UNSPECIFIED", "ALL_POWERED_ALL_SIGNIFICANT", "SOME_UNPOWERED_ALL_SIGNIFICANT", "SOME_MISSING", "SOME_POWERED_NOT_SIGNIFICANT", "SOME_NOT_SIGNIFICANT", "ALL_POWERED_NONE_SIGNIFICANT", "WITHOUT_NIM_SOME_DETERIORATED", "WITHOUT_NIM_NONE_DETERIORATED", "SOME_UNPOWERED_UNKNOWN_SIGNIFICANCE", "ALL_POWERED_UNKNOWN_SIGNIFICANCE", "NO_GUARDRAILS", "WAIT_FOR_END", "UNSPECIFIED" ], "example": "ALL_POWERED_ALL_SIGNIFICANT", "description": "" }, "quality": { "type": "string", "enum": [ "QUALITY_UNSPECIFIED", "ALL_SUCCEEDED", "SOME_FAILED", "SOME_PENDING", "UNSPECIFIED" ], "example": "ALL_SUCCEEDED", "description": "" }, "success": { "type": "string", "enum": [ "SUCCESS_UNSPECIFIED", "NO_SUCCESS_METRIC", "SOME_POWERED_SIGNIFICANT", "SOME_UNPOWERED_SIGNIFICANT", "ALL_POWERED_NONE_SIGNIFICANT", "NONE_SIGNIFICANT", "SOME_UNPOWERED_UNKNOWN_SIGNIFICANCE", "ALL_POWERED_UNKNOWN_SIGNIFICANCE", "SOME_MISSING", "WAIT_FOR_END", "UNSPECIFIED" ], "example": "NO_SUCCESS_METRIC", "description": "" }, "tanking": { "type": "string", "enum": [ "TANKING_UNSPECIFIED", "ALL_SUCCEEDED", "SOME_FAILED", "SOME_PENDING", "NO_METRICS", "UNSPECIFIED" ], "example": "ALL_SUCCEEDED", "description": "" } }, "description": "" } }, "description": "" } } }, "description": "" } } }, "description": "The recommendations for each exposure filter" }, "treatmentRecommendations": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.RecommendationsData.TreatmentInformation", "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "example": "", "description": "" }, "recommendation": { "name": "confidence.experiments.abtest.v1.Abtest.RecommendationsData.TreatmentInformation.Recommendation", "type": "object", "required": ["shipping", "status"], "properties": { "shipping": { "type": "string", "enum": [ "SHIPPING_UNSPECIFIED", "SHIP", "SHIP_WITH_CAUTION", "CONTINUE", "END", "ABORT", "DONT_SHIP", "WAIT_FOR_DATA", "ENOUGH_DATA_COLLECTED", "UNSPECIFIED" ], "example": "SHIP", "description": "" }, "status": { "name": "confidence.experiments.abtest.v1.Abtest.RecommendationsData.TreatmentInformation.Recommendation.RecommendationStatus", "type": "object", "required": ["guardrail", "success", "tanking"], "properties": { "guardrail": { "type": "string", "enum": [ "GUARDRAIL_UNSPECIFIED", "ALL_POWERED_ALL_SIGNIFICANT", "SOME_UNPOWERED_ALL_SIGNIFICANT", "SOME_MISSING", "SOME_POWERED_NOT_SIGNIFICANT", "SOME_NOT_SIGNIFICANT", "ALL_POWERED_NONE_SIGNIFICANT", "WITHOUT_NIM_SOME_DETERIORATED", "WITHOUT_NIM_NONE_DETERIORATED", "SOME_UNPOWERED_UNKNOWN_SIGNIFICANCE", "ALL_POWERED_UNKNOWN_SIGNIFICANCE", "NO_GUARDRAILS", "WAIT_FOR_END", "UNSPECIFIED" ], "example": "ALL_POWERED_ALL_SIGNIFICANT", "description": "" }, "quality": { "type": "string", "enum": [ "QUALITY_UNSPECIFIED", "ALL_SUCCEEDED", "SOME_FAILED", "SOME_PENDING", "UNSPECIFIED" ], "example": "ALL_SUCCEEDED", "description": "" }, "success": { "type": "string", "enum": [ "SUCCESS_UNSPECIFIED", "NO_SUCCESS_METRIC", "SOME_POWERED_SIGNIFICANT", "SOME_UNPOWERED_SIGNIFICANT", "ALL_POWERED_NONE_SIGNIFICANT", "NONE_SIGNIFICANT", "SOME_UNPOWERED_UNKNOWN_SIGNIFICANCE", "ALL_POWERED_UNKNOWN_SIGNIFICANCE", "SOME_MISSING", "WAIT_FOR_END", "UNSPECIFIED" ], "example": "NO_SUCCESS_METRIC", "description": "" }, "tanking": { "type": "string", "enum": [ "TANKING_UNSPECIFIED", "ALL_SUCCEEDED", "SOME_FAILED", "SOME_PENDING", "NO_METRICS", "UNSPECIFIED" ], "example": "ALL_SUCCEEDED", "description": "" } }, "description": "" } }, "description": "" } } }, "description": "The treatment recommendations" } } }, "confidence.experiments.abtest.v1.Abtest.ReportData": { "type": "object", "description": "Module data for report", "properties": { "name": { "type": "string", "example": "", "description": "The report name" }, "sections": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem", "type": "object", "required": ["id"], "properties": { "hypothesisData": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.HypothesisData", "type": "object", "required": [], "properties": { "hypothesis": { "type": "string", "example": "", "description": "The hypothesis text" } }, "description": "The hypothesis data" }, "id": { "type": "string", "example": "", "description": "The section id" }, "imagesData": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.ImagesData", "type": "object", "required": [], "properties": { "images": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.ImagesData.ImageData", "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "example": "", "description": "The image id" }, "imageUri": { "type": "string", "example": "", "description": "The image URI" }, "label": { "type": "string", "example": "", "description": "The image label" }, "text": { "type": "string", "example": "", "description": "The image text" } } }, "description": "The images" } }, "description": "The images data" }, "metricsData": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.MetricsData", "type": "object", "required": [], "properties": { "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.MetricsData.Metric", "type": "object", "required": [], "properties": { "hidden": { "type": "boolean", "example": true, "description": "Whether the metric is hidden" }, "metric": { "type": "string", "example": "", "description": "A resource name on the format metrics/abc" }, "metricName": { "type": "string", "example": "", "description": "The metric name" }, "treatments": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.MetricsData.Metric.MetricTreatmentConfig", "type": "object", "required": ["treatment"], "properties": { "hidden": { "type": "boolean", "example": true, "description": "Whether the treatment is hidden" }, "treatment": { "type": "string", "example": "", "description": "The treatment id" } } }, "description": "The treatment configurations" } } }, "description": "The metrics" } }, "description": "The metrics data" }, "nextData": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.NextData", "type": "object", "required": [], "properties": { "text": { "type": "string", "example": "", "description": "The next steps text" }, "title": { "type": "string", "example": "", "description": "The next steps title" } }, "description": "The next steps data" }, "outcomeData": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.OutcomeData", "type": "object", "required": [], "properties": { "conclusion": { "type": "string", "example": "", "description": "The conclusion" }, "outcome": { "type": "string", "example": "", "description": "The outcome" } }, "description": "The outcome data" }, "recommendationsData": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.RecommendationsData", "type": "object", "required": [], "properties": { "content": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.RecommendationsData.RecommendationsContent", "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "example": "", "description": "The content id" }, "shippingRecommendation": { "type": "string", "example": "", "description": "The shipping recommendation" }, "text": { "type": "string", "example": "", "description": "The recommendation text" }, "variant": { "type": "string", "example": "", "description": "The variant" } } }, "description": "The recommendation content" } }, "description": "The recommendations data" }, "resultsData": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.ResultsData", "type": "object", "required": [], "properties": { "text": { "type": "string", "example": "", "description": "The results text" }, "title": { "type": "string", "example": "", "description": "The results title" } }, "description": "The results data" }, "summaryData": { "name": "confidence.experiments.abtest.v1.Abtest.ReportData.SectionsItem.SummaryData", "type": "object", "required": [], "properties": { "imageUri": { "type": "string", "example": "", "description": "The summary image URI" }, "text": { "type": "string", "example": "", "description": "The summary text" }, "title": { "type": "string", "example": "", "description": "The summary title" } }, "description": "The summary data" } } }, "description": "The report sections" } } }, "confidence.experiments.abtest.v1.Abtest.ReviewsData": { "type": "object", "description": "Module data for reviews", "properties": { "approvalRequired": { "type": "boolean", "example": true, "description": "Whether approval is required" }, "optionalReviews": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReviewsData.SurfaceReviewData", "type": "object", "required": ["state"], "properties": { "responses": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReviewsData.SurfaceReviewData.Response", "type": "object", "required": ["reviewer", "state"], "properties": { "commentId": { "type": "string", "example": "", "description": "The comment id" }, "groups": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "id": { "type": "string", "example": "", "description": "The response id" }, "reviewer": { "type": "string", "example": "", "description": "A resource name on the format identities/abc" }, "stale": { "type": "boolean", "example": true, "description": "Whether the review is stale" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The review state" } } }, "description": "The review responses" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The review state" }, "surface": { "type": "string", "example": "", "description": "A resource name on the format surfaces/abc" } } }, "description": "The optional reviews for each surface" }, "requiredReviews": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReviewsData.SurfaceReviewData", "type": "object", "required": ["state"], "properties": { "responses": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.ReviewsData.SurfaceReviewData.Response", "type": "object", "required": ["reviewer", "state"], "properties": { "commentId": { "type": "string", "example": "", "description": "The comment id" }, "groups": { "type": "array", "items": { "type": "string", "example": "" }, "description": "Resource names on the format identities/abc" }, "id": { "type": "string", "example": "", "description": "The response id" }, "reviewer": { "type": "string", "example": "", "description": "A resource name on the format identities/abc" }, "stale": { "type": "boolean", "example": true, "description": "Whether the review is stale" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The review state" } } }, "description": "The review responses" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The review state" }, "surface": { "type": "string", "example": "", "description": "A resource name on the format surfaces/abc" } } }, "description": "The required reviews for each surface" }, "reviewId": { "type": "string", "example": "", "description": "The review id" }, "status": { "type": "string", "enum": [ "STATUS_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "REQUESTED", "STALE" ], "example": "PENDING", "description": "The overall review status" } } }, "confidence.experiments.abtest.v1.Abtest.SampleSizeData": { "type": "object", "description": "Module data for samplesize", "properties": { "error": { "type": "string", "example": "", "description": "Error message if any" }, "exposure": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.Exposure", "type": "object", "required": [], "properties": { "assignmentTable": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.Exposure.AssignmentTable", "type": "object", "required": [], "properties": { "assignmentTable": { "type": "string", "example": "", "description": "The assignment table name" }, "customEndTime": { "type": "string", "example": "", "description": "Custom end time for sample size calculation" }, "customStartTime": { "type": "string", "example": "", "description": "Custom start time for sample size calculation" }, "filters": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.Exposure.AssignmentTable.SampleSizeFilter", "type": "object", "required": [], "properties": { "exposureFilter": { "type": "string", "example": "", "description": "Exposure filter name" } }, "description": "The filters" }, "runtime": { "type": "string", "example": "", "description": "The runtime duration" }, "samplingFactor": { "type": "number", "example": 3.14, "description": "Factor to scale up expected sample sizes when using sampled data (default 1.0)" } }, "description": "The assignment table configuration" }, "endTime": { "type": "string", "example": "", "description": "The end time" }, "existingInstance": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.Exposure.ExistingInstance", "type": "object", "required": ["workflowInstance"], "properties": { "exposureTableSchedule": { "type": "string", "example": "", "description": "The exposure table schedule" }, "workflowInstance": { "type": "string", "example": "", "description": "A resource name on the format workflowInstances/abc" } }, "description": "The existing workflow instance" }, "exposureCalculationName": { "type": "string", "example": "", "description": "The exposure calculation resource name" }, "startTime": { "type": "string", "example": "", "description": "The start time" } }, "description": "The exposure configuration" }, "exposureCalculationName": { "type": "string", "example": "", "description": "The exposure calculation resource name" }, "exposureSource": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.ExposureSource", "type": "object", "required": [], "properties": { "assignmentTable": { "type": "string", "example": "", "description": "The assignment table name" }, "customEndTime": { "type": "string", "example": "", "description": "Custom end time for sample size calculation" }, "customStartTime": { "type": "string", "example": "", "description": "Custom start time for sample size calculation" }, "exposureTableSchedule": { "type": "string", "example": "", "description": "The exposure table schedule" }, "filters": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.ExposureSource.SampleSizeFilter", "type": "object", "required": [], "properties": { "assignmentFilter": { "name": "confidence.metrics.v1.Filter", "type": "object", "required": ["criteria", "expression"], "properties": { "criteria": { "type": "object", "additionalProperties": { "name": "confidence.metrics.v1.Filter.Criterion", "type": "object", "required": [], "properties": { "attribute": { "name": "confidence.metrics.v1.Filter.Criterion.AttributeCriterion", "type": "object", "required": ["attribute"], "properties": { "attribute": { "type": "string", "example": "", "description": "The name of the attribute" }, "eqRule": { "name": "confidence.metrics.v1.Filter.EqRule", "type": "object", "required": ["value"], "properties": { "value": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be equal to the criterion" }, "setRule": { "name": "confidence.metrics.v1.Filter.SetRule", "type": "object", "required": ["values"], "properties": { "values": { "type": "array", "items": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be in the set of values" }, "rangeRule": { "name": "confidence.metrics.v1.Filter.RangeRule", "type": "object", "required": [], "properties": { "startInclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "startExclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "endInclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "endExclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be in the range" } }, "description": "A criterion for an attribute (typically a table column)" } } }, "description": "The filter criteria" }, "expression": { "name": "confidence.metrics.v1.Expression", "type": "object", "required": [], "properties": { "ref": { "type": "string", "example": "", "description": "" }, "not": { "type": "object", "description": "A boolean expression with leaf nodes that reference criteria elements\n " }, "and": { "name": "confidence.metrics.v1.Expression.Operands", "type": "object", "required": ["operands"], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements\n " } }, "description": "" }, "or": { "name": "confidence.metrics.v1.Expression.Operands", "type": "object", "required": ["operands"], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements\n " } }, "description": "" } }, "description": "The filter expressions" } }, "description": "Assignment filter" }, "entityFilter": { "name": "confidence.metrics.v1.ExposureCalculationSpec.EntityFilter", "type": "object", "required": ["dimensionTable"], "properties": { "dimensionTable": { "type": "string", "example": "", "description": "Resource name of a dimension table" }, "filter": { "name": "confidence.metrics.v1.Filter", "type": "object", "required": ["criteria", "expression"], "properties": { "criteria": { "type": "object", "additionalProperties": { "name": "confidence.metrics.v1.Filter.Criterion", "type": "object", "required": [], "properties": { "attribute": { "name": "confidence.metrics.v1.Filter.Criterion.AttributeCriterion", "type": "object", "required": ["attribute"], "properties": { "attribute": { "type": "string", "example": "", "description": "The name of the attribute" }, "eqRule": { "name": "confidence.metrics.v1.Filter.EqRule", "type": "object", "required": ["value"], "properties": { "value": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be equal to the criterion" }, "setRule": { "name": "confidence.metrics.v1.Filter.SetRule", "type": "object", "required": ["values"], "properties": { "values": { "type": "array", "items": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be in the set of values" }, "rangeRule": { "name": "confidence.metrics.v1.Filter.RangeRule", "type": "object", "required": [], "properties": { "startInclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "startExclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "endInclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " }, "endExclusive": { "name": "confidence.metrics.v1.Filter.Value", "type": "object", "required": [], "properties": { "boolValue": { "type": "boolean", "example": true, "description": "" }, "numberValue": { "type": "number", "example": 3.14, "description": "" }, "stringValue": { "type": "string", "example": "", "description": "" }, "timestampValue": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "" }, "nullValue": { "name": "confidence.metrics.v1.Filter.Value.Null", "type": "object", "required": [], "properties": { "dummyField": { "type": "string", "example": "", "description": "Dummy field to make the type not empty" } }, "description": "" } }, "description": "equality (==, !=, ∈) defined for all types\n comparison ({\"<\"}, {\"<\"}=, {\">\"}, {\">\"}=) defined for number, timestamp, version\n " } }, "description": "The value must be in the range" } }, "description": "A criterion for an attribute (typically a table column)" } } }, "description": "The filter criteria" }, "expression": { "name": "confidence.metrics.v1.Expression", "type": "object", "required": [], "properties": { "ref": { "type": "string", "example": "", "description": "" }, "not": { "type": "object", "description": "A boolean expression with leaf nodes that reference criteria elements\n " }, "and": { "name": "confidence.metrics.v1.Expression.Operands", "type": "object", "required": ["operands"], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements\n " } }, "description": "" }, "or": { "name": "confidence.metrics.v1.Expression.Operands", "type": "object", "required": ["operands"], "properties": { "operands": { "type": "array", "items": { "type": "object" }, "description": "A boolean expression with leaf nodes that reference criteria elements\n " } }, "description": "" } }, "description": "The filter expressions" } }, "description": "A filter to apply to the entity table used for entity filtering" } }, "description": "Entity filter" }, "exposureFilter": { "type": "string", "example": "", "description": "Exposure filter name" } }, "description": "The filters" }, "runtime": { "type": "string", "example": "", "description": "The runtime duration" }, "samplingFactor": { "type": "number", "example": 3.14, "description": "Factor to scale up expected sample sizes when using sampled data (default 1.0)" }, "workflowInstance": { "type": "string", "example": "", "description": "A resource name on the format workflowInstances/abc" } }, "description": "The exposure source configuration" }, "hasCustomizedExposureSource": { "type": "boolean", "example": true, "description": "Whether the user has explicitly customized the exposure source. When true, the flag filter sync is disabled. Missing (undefined) on old instances disables sync for backwards compatibility." }, "metrics": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.SampleSizeMetric", "type": "object", "required": ["metric"], "properties": { "error": { "type": "string", "example": "", "description": "Error message if any" }, "forecastedData": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.SampleSizeMetric.ForecastedDataPoint", "type": "object", "required": ["dayIndex"], "properties": { "dayIndex": { "type": "integer", "example": 1, "description": "Day index since exposure start (0-based)" }, "expectedSampleSize": { "type": "integer", "example": 1, "description": "The expected/forecasted sample size" }, "requiredSampleSize": { "type": "integer", "example": 1, "description": "The required sample size" } } }, "description": "Forecasted time series data" }, "metric": { "type": "string", "example": "", "description": "The metric name" }, "metricCalculationName": { "type": "string", "example": "", "description": "The metric calculation resource name" }, "observedData": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.SampleSizeMetric.ObservedDataPoint", "type": "object", "required": ["dayIndex"], "properties": { "dayIndex": { "type": "integer", "example": 1, "description": "Day index since exposure start (0-based)" }, "expectedSampleSize": { "type": "integer", "example": 1, "description": "The expected sample size" }, "mean": { "type": "number", "example": 3.14, "description": "The mean value" }, "requiredSampleSize": { "type": "integer", "example": 1, "description": "The required sample size" }, "variance": { "type": "number", "example": 3.14, "description": "The variance" } } }, "description": "Observed time series data" }, "requiredSampleSize": { "type": "integer", "example": 1, "description": "The required sample size" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "ERROR", "NO_PLANNED_EFFECT_SIZE", "OK" ], "example": "ERROR", "description": "The state of the metric" }, "summaryStats": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.SampleSizeMetric.SummaryStats", "type": "object", "required": [], "properties": { "count": { "type": "integer", "example": 1, "description": "The count" }, "mean": { "type": "number", "example": 3.14, "description": "The mean value" }, "variance": { "type": "number", "example": 3.14, "description": "The variance" }, "varianceReductionRate": { "type": "number", "example": 3.14, "description": "The variance reduction rate" } }, "description": "Summary statistics for the metric" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "UNKNOWN", "SUCCESS", "GUARDRAIL", "DETERIORATION", "QUALITY" ], "example": "UNKNOWN", "description": "The metric type" } } }, "description": "The metrics for sample size calculation" }, "requiredSampleSize": { "type": "integer", "example": 1, "description": "The required sample size" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "EMPTY", "CALCULATING_EXPOSURE", "CALCULATING_METRICS", "DONE", "ERROR", "STALE", "CANCELED" ], "example": "EMPTY", "description": "The sample size calculation state" }, "statsParameters": { "name": "confidence.experiments.abtest.v1.Abtest.SampleSizeData.StatsParameters", "type": "object", "required": ["alpha", "power", "testHorizonStrategy"], "properties": { "allocationProportion": { "type": "string", "example": "", "description": "The allocation proportion used in the calculation, for scaling when allocation changes" }, "alpha": { "type": "number", "example": 3.14, "description": "Significance level" }, "power": { "type": "number", "example": 3.14, "description": "Statistical power" }, "testHorizonStrategy": { "type": "string", "enum": [ "TEST_HORIZON_STRATEGY_UNSPECIFIED", "FIXED_HORIZON", "SEQUENTIAL" ], "example": "FIXED_HORIZON", "description": "Test horizon strategy" } }, "description": "The stats parameters" }, "useScheduledCalculation": { "type": "boolean", "example": true, "description": "Use scheduled calculations instead of one-time calculations" } } }, "confidence.experiments.abtest.v1.Abtest.StatsData": { "type": "object", "description": "Module data for stats", "properties": { "alpha": { "type": "number", "example": 3.14, "description": "Significance level (defaults to 0.05)" }, "analysisResult": { "type": "string", "example": "", "description": "A resource name on the format analysisResults/abc" }, "analysisResults": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.StatsData.AnalysisResult", "type": "object", "required": ["analysisResult"], "properties": { "analysisResult": { "type": "string", "example": "", "description": "A resource name on the format analysisResults/abc" }, "exposureFilterName": { "type": "string", "example": "", "description": "The exposure filter name" } } }, "description": "Analysis result resource names (multiple exposure filters)" }, "fallbackSampleSize": { "type": "string", "example": "", "description": "Fallback sample size when metric-specific size is not set" }, "metricInformation": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.StatsData.MetricInformation", "type": "object", "required": ["metricName"], "properties": { "expectedSampleSize": { "type": "string", "example": "", "description": "Expected sample size for this metric" }, "metricName": { "type": "string", "example": "", "description": "The metric name" } } }, "description": "Expected sample sizes for metrics" }, "metricMethods": { "type": "array", "items": { "name": "confidence.experiments.abtest.v1.Abtest.StatsData.Method", "type": "object", "required": ["method", "metricName"], "properties": { "method": { "type": "string", "enum": [ "METHOD_UNSPECIFIED", "Z_TEST", "GST_Z_TEST", "ASYMP_CS", "RATIO", "GST_RATIO", "ASYMP_CS_RATIO", "CHI2", "UNKNOWN" ], "example": "Z_TEST", "description": "The statistical method" }, "metricName": { "type": "string", "example": "", "description": "The metric name" } } }, "description": "Statistical methods used for each metric" }, "power": { "type": "number", "example": 3.14, "description": "Statistical power (defaults to 0.8)" }, "testHorizonStrategy": { "type": "string", "enum": [ "TEST_HORIZON_STRATEGY_UNSPECIFIED", "FIXED_HORIZON", "SEQUENTIAL" ], "example": "FIXED_HORIZON", "description": "Testing strategy (fixed horizon or sequential)" } } } }, "securitySchemes": { "admin": { "type": "http", "scheme": "bearer" } } } }